format | /mod.ts | format@1.1.0

function format

import { format } from "https://deno.land/x/format@1.1.0/mod.ts";

format<ParamKey extends string = never, U extends Placeholder = { prefix: Delimiter.Prefix; suffix: Delimiter.Suffix; }, T extends string = string>(

formatString: T,

params: Readonly<Record<IsNever<ParamKey> extends true ? ExtractSpecifier<T, U> : ParamKey, unknown>>,

options?: Readonly<FormatOptions<U>>,

): string

Interpolate JavaScript value into format string.

Examples

Example 1

import { format } from "@miyauci/format";
import { assertEquals } from "@std/assert";

assertEquals(format("{0} {name}!", { 0: "Hello", name: "Tom" }), "Hello Tom!");

//@ts-expect-error it should provide params.0 and params.name
format("{0} {name}!", {});

Type Parameters

optional

ParamKey extends string = never

optional

U extends Placeholder = { prefix: Delimiter.Prefix; suffix: Delimiter.Suffix; }

optional

T extends string = string

Parameters

formatString: T

params: Readonly<Record<IsNever<ParamKey> extends true ? ExtractSpecifier<T, U> : ParamKey, unknown>>

optional

options: Readonly<FormatOptions<U>>

Returns

string