An open API service indexing awesome lists of open source software.

https://github.com/artdecocode/my-new-package

A test package to show the capabilities.
https://github.com/artdecocode/my-new-package

Last synced: about 2 months ago
JSON representation

A test package to show the capabilities.

Awesome Lists containing this project

README

          

# my-new-package

[![npm version](https://badge.fury.io/js/my-new-package.svg)](https://npmjs.org/package/my-new-package)

`my-new-package` is a new Node.js npm package. A test package to show the capabilities.

```sh
yarn add -E my-new-package
```

## Table Of Contents

- [Table Of Contents](#table-of-contents)
- [API](#api)
* [`myNewPackage(arg1: string, arg2?: boolean)`](#mynewpackagearg1-stringarg2-boolean-void)

## API

The package is available by importing its default function:

```js
import myNewPackage from 'my-new-package'
```

### `myNewPackage(`
  `arg1: string,`
  `arg2?: boolean,`
`): void`

Call this function to get the result you want.

```js
/* yarn example */
import myNewPackage from 'my-new-package'

(async () => {
await myNewPackage()
})()
```

---

(c) [Art Deco Code][1] 2018

[1]: https://artdeco.bz