README.md

jsbatch-strings

string constants for use with package jsbatchrun and its plugins.

This package simply provides a number of string constants, used over and over by jsbatchrun.
Feel free to incorporate them into your plugins.

content

• Usage (see further down this page)

  • Getting started guide
  • Usage and examples

• Developers

  • Testing jsbatch-strings
  • Code coverage of tests for jsbatch-strings
  • Build jsbatch-strings from scratch
  • NPM integration of jsbatch-strings
  • Frameworks used for testing, building, etc.
  • API of package jsbatch-strings (self generated with jsbatch-strings)

getting started

This package is required by jsbatchrun or it may be incorporate into your own plugins.

install

This guide assumes, that you are familiar with the use of npm.

npm install jsbatch-strings --save

prerequisites

No prerequisites.

usage

const helpstring = require( "jsbatch-strings" ).HELP;
console.log( helpstring );
// Will output "help" or whatever 'helpstring' currently is used by jsbatchrun.

const mystringtable = Object.assign({ my: "stringtable" }, require( "jsbatch-strings" ));
console.log( mystringtable.HELP );
// Will output "help" or whatever 'helpstring' currently is used by jsbatchrun.