https://github.com/artdecocode/completest
IDE autocompletion testing for perfect DevX.
https://github.com/artdecocode/completest
Last synced: 3 months ago
JSON representation
IDE autocompletion testing for perfect DevX.
- Host: GitHub
- URL: https://github.com/artdecocode/completest
- Owner: artdecocode
- License: mit
- Created: 2018-10-02T21:30:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-02T21:31:20.000Z (over 7 years ago)
- Last Synced: 2025-06-04T02:44:08.947Z (7 months ago)
- Language: JavaScript
- Homepage: https://artdeco.bz
- Size: 11.7 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
# completest
[](https://npmjs.org/package/completest)
`completest` is IDE autocompletion testing for perfect DevX.
```sh
yarn add -E completest
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`completest(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 completest from 'completest'
```
## `completest(`
`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 completest from 'completest'
(async () => {
const res = await completest({
text: 'example',
})
console.log(res)
})()
```
```
example
```
## Copyright
(c) [Art Deco][1] 2018
[1]: https://artdeco.bz
