my-new-package

my-new-package is {{ description }}

yarn add my-new-package

Table Of Contents

• Table Of Contents
• API
• async myNewPackage(config: !Config): string
  • Config
• CLI
• Copyright & License

API

The package is available by importing its default function:

importmyNewPackagefrom'my-new-package'

async myNewPackage(
config: !Config,
): string

{{ description }}

• config*!Config: The config.

Config: Options for the program.

Name	Type	Description	Default
shouldRun	boolean	A boolean option.	true
text	string	A text to return.	-

importmyNewPackagefrom'my-new-package'(async()=>{constres=awaitmyNewPackage({text: 'example',})console.log(res)})()

my-new-package called with example
example

CLI

The package can also be used from the CLI.

Argument	Short	Description
input		The path to the input file.
--output	-o	Where to save the output. By default prints to stdout. Default -.
--init	-i	Initialise in the current folder.
--help	-h	Print the help information and exit.
--version	-v	Show the version's number and exit.

{{ description }}
mnp input [-o output] [-ihv]
input The path to the input file.
--output, -o Where to save the output. By default prints to stdout.
Default: -.
--init, -i Initialise in the current folder.
--help, -h Print the help information and exit.
--version, -v	Show the version's number and exit.
Example:
mnp example.txt -o out.txt

Copyright & License

{{ license_name }}

© {{ trademark }} 2020