amazing-package

amazing-package is Hello World

yarn add amazing-package

Table Of Contents

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

API

The package is available by importing its default function:

import amazingPackage from 'amazing-package'

async amazingPackage(
  config: !Config,
): string

Hello World

• 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.	-

import amazingPackage from 'amazing-package'

(async () => {
  const res = await amazingPackage({
    text: 'example',
  })
  console.log(res)
})()

amazing-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.

Hello World

  amazing-package 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:

    amazing-package example.txt -o out.txt

Copyright & License

GNU Affero General Public License v3.0

© Art Deco™ 2020