npmpackage.info

Gathering detailed insights and metrics for @brdu/expand-template

@brdu/expand-template - 1.0.2 | npmpackage.info

@brdu/expand-template

Expands placeholders in a string template based on named or positional arguments. It's also possible to use complex templates including lists and conditionals.

1.0.2

MIT

JavaScript

22.02 kB

1.7

Installations

npm install @brdu/expand-template

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.18.3

NPM Version

6.14.6 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

buffolander

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

1 Stars

4 Commits

1 Watchers

1 Branches

1 Contributors

Updated on Mar 05, 2023

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.2

Package Id

@brdu/expand-template@1.0.2

Unpacked Size

22.02 kB

Size

6.43 kB

File Count

NPM Version

6.14.6

Node Version

12.18.3

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

lodash

Dev Dependencies

eslint eslint-config-airbnb-base eslint-plugin-import jest

Expands placeholders in a string template based on named or positional arguments. It's also possible to use complex templates including lists and conditionals.

Installation

$ npm install --save @brdu/expand-template

Usage

Simple templates accept both named and positional arguments, as well as nested named arguments.

The placeholder format for this template is %(key). Simple templates are also used within conditional templates and list templates.

const expand = require('@brdu/expand-template')

let template = 'Hello %(name). How are you doing today?'
let args = { name: 'Buffolander' }
console.info(expand({ template, args }))
// 'Hello Buffolander. How are you doing today?'

template = 'Hello %(1) and %(0). How are you doing?'
args = ['Buffolander', 'Kelly']
console.info(expand({ template, args }))
// 'Hello Kelly and Buffolander. How are you doing?'

template = '...schedule an appointment with Dr. %(md.last_name)'
args = {
  patient: 'any',
  md: {
    first_name: 'John',
    last_name: 'Smith',
  },
}
console.info(expand({ template, args }))
// '...schedule an appointment with Dr. Smith'

Conditional templates

Conditional templates use one or more keys to validate wether to expand variables within that section or to remove the section altogether.

The placeholder format for this template is [?(keyA, keyB) <simpleTemplate>].

template = 'Hello world! [?(weather, city) It\'s a %(weather) day in %(city).]'
args = { weather: 'sunny' }
console.info(expand({ template, args }))
// 'Hello world!' // city missing in args; conditional section removed

args = { ...args, city: 'Miami' }
console.info(expand({ template, args }))
// 'Hello world! It\'s a sunny day in Miami.'

List templates

Finally, list templates take an array as input for repeating text sections. The placeholder format for this template is [[%(key) <simpleTemplate>]]. On this template index is a reserved key, used to print out the position in the array.

template = 'Hello there, please [[%(directory) press %(index) for %(department)]].'
args = {
  company: 'Acme',
  directory: [{
    department: 'Sales',
  }, {
    department: 'Support',
  }],
}
console.info(expand({ template, args }))
// 'Hello there, please press 0 for Sales, press 1 for Support.'

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More