Skip to main content

A module for literal string template.

Works with
This package works with Bun
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
It is unknown whether this package works with Browsers
JSR Score
94%
Published
2 months ago

Replaceholder (TypeScript)

⚖ī¸ MIT

🗂ī¸ GitHub: hugoalh-studio/replaceholder-ts JSR: @hugoalh/replaceholder

🆙 Latest Release Version (Latest Release Date)

A TypeScript module for literal string template.

đŸŽ¯ Target

  • Bun ^ v1.0.0
  • Cloudflare Workers
  • Deno >= v1.34.0 / >= v1.41.1 (Via JSR)

    🛡ī¸ Require Permission

    N/A

  • NodeJS >= v16.13.0

🔰 Usage

Via HTTPS

đŸŽ¯ Supported Target

  • Deno
  1. Import at the script (<ScriptName>.ts):
    • Via DenoPKG
      import ... from "https://denopkg.com/hugoalh-studio/replaceholder-ts[@<Tag>]/mod.ts";
      
    • Via GitHub Raw (Require Tag)
      import ... from "https://raw.githubusercontent.com/hugoalh-studio/replaceholder-ts/<Tag>/mod.ts";
      
    • Via Pax
      import ... from "https://pax.deno.dev/hugoalh-studio/replaceholder-ts[@<Tag>]/mod.ts";
      

    ℹī¸ Note

    Although it is recommended to import the entire module with the main path mod.ts, it is also able to import part of the module with sub path if available, but do not import if:

    • it's file path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
    • it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
    • it's symbol has an underscore prefix (e.g.: export function _baz() {}).

    These elements are not considered part of the public API, thus no stability is guaranteed for them.

Via JSR With Native Support

đŸŽ¯ Supported Target

  • Deno
  1. Import at the script (<ScriptName>.ts):
    import ... from "jsr:@hugoalh/replaceholder[@<Tag>]";
    

    ℹī¸ Note

    Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.

Via JSR With NPM Compatibility Layer Support

đŸŽ¯ Supported Target

  • Bun
  • Cloudflare Workers
  • NodeJS
  1. Install via console/shell/terminal:
    • Via Bun
      bunx jsr add @hugoalh/replaceholder[@<Tag>]
      
    • Via NPM
      npx jsr add @hugoalh/replaceholder[@<Tag>]
      
    • Via PNPM
      pnpm dlx jsr add @hugoalh/replaceholder[@<Tag>]
      
    • Via Yarn
      yarn dlx jsr add @hugoalh/replaceholder[@<Tag>]
      
  2. Import at the script (<ScriptName>.ts):
    import ... from "@hugoalh/replaceholder";
    

    ℹī¸ Note

    Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.

🧩 API

  • class Replaceholder {
      constructor(options: ReplaceholderOptions = {}): Replaceholder;
      handle(item: string, data: KeyValueLike): string;
      static handle(item: string, data: KeyValueLike, options: ReplaceholderOptions = {}): string;
    }
    
  • function replaceholder(item: string, data: KeyValueLike, options: ReplaceholderOptions = {}): string;
    
  • interface ReplaceholderOptions {
      /**
       * Pattern for the tag close.
       * @default "}}"
       */
      close?: string;
      /**
       * Pattern for the tag open.
       * @default "{{"
       */
      open?: string;
    }
    
  • type KeyValueLike<V extends string = string> = { [key: string]: V; } | Map<string, V> | Record<string, V>;
    

ℹī¸ Note

For the prettier documentation, can visit via:

✍ī¸ Example

  • new Replaceholder().handle("This is {{name}}, {{age}} years old, and likes to use \"\\{{replaceholder}}\"!", {
      age: "18",
      name: "Bob"
    });
    //=> "This is Bob, 18 years old, and likes to use \"{{replaceholder}}\"!"
    
Built and signed on
GitHub Actions
View transparency log

Add Package

deno add @hugoalh/replaceholder

Import symbol

import * as mod from "@hugoalh/replaceholder";

Add Package

npx jsr add @hugoalh/replaceholder

Import symbol

import * as mod from "@hugoalh/replaceholder";

Add Package

yarn dlx jsr add @hugoalh/replaceholder

Import symbol

import * as mod from "@hugoalh/replaceholder";

Add Package

pnpm dlx jsr add @hugoalh/replaceholder

Import symbol

import * as mod from "@hugoalh/replaceholder";

Add Package

bunx jsr add @hugoalh/replaceholder

Import symbol

import * as mod from "@hugoalh/replaceholder";