https://github.com/artdecocode/ttt
t
https://github.com/artdecocode/ttt
Last synced: 5 months ago
JSON representation
t
- Host: GitHub
- URL: https://github.com/artdecocode/ttt
- Owner: artdecocode
- License: mit
- Created: 2019-03-07T19:35:06.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-07T19:35:22.000Z (almost 7 years ago)
- Last Synced: 2025-07-14T21:41:52.607Z (6 months ago)
- Language: JavaScript
- Homepage: https://artd.eco
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @artdeco/ttt
[](https://npmjs.org/package/@artdeco/ttt)
`@artdeco/ttt` is t
```sh
yarn add -E @artdeco/ttt
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`ttt(arg1: string, arg2?: boolean)`](#mynewpackagearg1-stringarg2-boolean-void)
* [`Config`](#type-config)
- [Copyright](#copyright)
## API
The package is available by importing its default function:
```js
import ttt from '@artdeco/ttt'
```
## `ttt(`
`arg1: string,`
`arg2?: boolean,`
`): void`
Call this function to get the result you want.
__`Config`__: Options for the program.
| Name | Type | Description | Default |
| --------- | --------- | ----------------- | ------- |
| shouldRun | _boolean_ | A boolean option. | `true` |
| __text*__ | _string_ | A text to return. | - |
```js
/* yarn example/ */
import ttt from '@artdeco/ttt'
(async () => {
const res = await ttt({
text: 'example',
})
console.log(res)
})()
```
```
example
```
## Copyright
(c) [Art Deco][1] 2019
[1]: https://artd.eco
