API reference / @chanx-js/client / core / formatPattern

Function: formatPattern()

function formatPattern(
   pattern, 
   params?, 
   encode?
): string;

Defined in: packages/protocol/src/pattern.ts:13

Fill a pattern's {placeholder}s.

Pass encode for URLs; topic strings stay raw because the server compares them verbatim.

Parameters

Parameter	Type
pattern	string
params	Record<string, string | number>
encode	(value) => string

Returns

string