fmt-subs

Home > fmt-subs > sub

sub() function

Constructs substitution

Signature:

export declare function sub(something: unknown, substitution: string): SubstitutionToken;

Parameters

Parameter	Type	Description
something	unknown	what to substitute
substitution	string	an actual string substitution

Returns:

SubstitutionToken

token that could be used inside of fmt template literal

Example

import { sub, fmt } from 'fmt-subs'

const fmtInstance = fmt`Hello, ${sub({ value: 'World' }, '%o')}!`

// deep equality
fmtInstance.assemble() == ['Hello, %o!', { value: 'World' }]

This site is open source. Improve this page.