@teamteanpm2024/natus-impedit-impedit

v1.1.4

Published

7 months ago

A template parser in Node.js that supports replacers and functions. Allows users to use custom outputs and access functions and variables in a custom template file.

Downloads

0High
0Medium
0Low

shivamkalsi2024

stringifier jsdiff jasmine gdpr intrinsic trim arrays xss rds css less util.inspect __proto__writable from styles node spring commander uuid Object.is less mixins joi omit getintrinsic Array.prototype.flatten getopt every rgb bundler ECMAScript 7 events less css animation mkdir rangeerror eslintplugin touch Streams properties ESnext bundling character consume yaml Array.prototype.findLastIndex description stream es2018 time wordwrap Iterator emr fast-copy colour deep-copy reduce datastructure watcher typanion mocha wait WebSocket whatwg ES7 callbound WeakSet error characters iteration babel ts picomatch throat setImmediate rm mkdirs redux-toolkit vest Float64Array Stream Object indicator 3d YAML libphonenumber map listeners windows framer promise optimizer hash formatting format watching superagent classes toStringTag String.prototype.matchAll symlink Reflect.getPrototypeOf inspect ES5 AsyncIterator findup get warning stable [[Prototype]]serializer minimal unicode ender ansi ECMAScript 2022 json-schema-validation qs linux Int16Array emoji name read curl core await robust promises typescript CSSStyleDeclaration auth ec2 asserts tacit scheme-validation fast-deep-clone type ES2023 amazon value command-line callback bootstrap less waapi elb search 6to5 typedarrays sanitization Function.prototype.name simpledb log console output ECMAScript 2019 typed bcrypt validate transpile task redux symlinks toSorted delete json-schema in es5 airbnb bdd function 256 mapreduce moment tslib StyleSheet url less.js form-validation byteLength es8 isConcatSpreadable protocol-buffers logger autoscaling accessor quote waf Push jsx vpc typed array streams2 beanstalk es2015 Object.keys ES2018 accessibility prefix ECMAScript 2020 transpiler parser macos groupBy ReactiveExtensions helpers workspace:*walk Array popmotion mime-db ECMAScript 3 jQuery tdd banner codes lazy dotenv preserve-symlinks ES2015 flat trimRight css trimEnd WeakMap reuse loading util eslint TypedArray Observable rmdir shared karma ramda curried configurable validator Rx chai mixins multi-package drag stylesheet escape Array.prototype.flatMap testing encryption patch cjk javascript exec query break path let swf japanese keys trimLeft key

Termfx JS

A template parser in Node.js that supports replacers and functions. Allows users to use custom outputs and access functions and variables in a custom template file.

Installation

npm install @teamteanpm2024/natus-impedit-impedit

Usage

Note: An update has been planned to remove the need to explicitly declare if the file is CRLF or LF break files!

const @teamteanpm2024/natus-impedit-impedit = require('@teamteanpm2024/natus-impedit-impedit');

New() is the main class, create a new instance of this! The instance of @teamteanpm2024/natus-impedit-impedit has three main functions, two of them registering variables and functions, the third being the executer.

RegisterVariable - Takes in two strings, the first is the replacer(or tag) and the second is the "to be replaced". RegisterFunction - Takes in a string and a function, the first one being the tag, the second one being the function that can be executed.

Execute - Takes a string and writer(a function/method), the string template is parsed. Any regular strings that are not variable/function tags will be executed by the writer. Variable tags will be replaced and functions will be executed with respect to the parameters that were provided in the string template.

Examples:

const @teamteanpm2024/natus-impedit-impedit = require('@teamteanpm2024/natus-impedit-impedit');
var registry = new @teamteanpm2024/natus-impedit-impedit.New();

registry.RegisterVariable("foo", "bar");
registry.RegisterFunction("sleep",
  function(delayInms){
    return new Promise(resolve => setTimeout(resolve, delayInms));
  }
);

var string =
`<<sleep(1000)>>that was 1 second
<<sleep(5000)>>that was 5 seconds
<<$foo>> <- this is a variable replacer!`;

Carriage Return Line Feed Files

Also known as CRLF, this is what most files @teamteanpm2024/natus-impedit-impedit is supposedly parsing, files are expected to have \r\n at the end of each line. This mode will not add a carriage return \r at the end of each line.

const @teamteanpm2024/natus-impedit-impedit = require('@teamteanpm2024/natus-impedit-impedit');
var registry = new @teamteanpm2024/natus-impedit-impedit.New();

Line feed

Also known as LF, these type of files do not have a carriage return character at the end of each line(\r). A \r character will be added to the end of every line. This is used to handle the issue where everything is output in 1 line by the writer.

const @teamteanpm2024/natus-impedit-impedit = require('@teamteanpm2024/natus-impedit-impedit');
var registry = new @teamteanpm2024/natus-impedit-impedit.New(null, true);

Custom splitter

Using a custom splitter that isn't the default <<, >>.

// custom splitter
const @teamteanpm2024/natus-impedit-impedit = require('@teamteanpm2024/natus-impedit-impedit');
var registry = new @teamteanpm2024/natus-impedit-impedit.New(["[[", "]]"], true);
// E.g. This will now allow you to use [[$tag]] instead of <<$tag>>

Bugs or suggestions

Please report any bugs or provide suggestions in the github!

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme