https://github.com/idiocc/vscode-jsdoc-1
The test of jsdoc
https://github.com/idiocc/vscode-jsdoc-1
Last synced: about 1 year ago
JSON representation
The test of jsdoc
- Host: GitHub
- URL: https://github.com/idiocc/vscode-jsdoc-1
- Owner: idiocc
- License: mit
- Created: 2019-06-19T23:12:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-19T23:46:42.000Z (almost 7 years ago)
- Last Synced: 2025-02-15T07:48:59.723Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://idio.cc
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @idio/vscode-jsdoc-1
[](https://npmjs.org/package/@idio/vscode-jsdoc-1)
`@idio/vscode-jsdoc-1` is The test of jsdoc
```sh
yarn add @idio/vscode-jsdoc-1
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`vscodeJsdoc_1(arg1: string, arg2?: boolean)`](#mynewpackagearg1-stringarg2-boolean-void)
* [`_@idio/vscode-jsdoc-1.Config`](#type-_@idio/vscode-jsdoc-1config)
- [Copyright](#copyright)
## API
The package is available by importing its default function:
```js
import vscodeJsdoc_1 from '@idio/vscode-jsdoc-1'
```
## `vscodeJsdoc_1(`
`arg1: string,`
`arg2?: boolean,`
`): void`
Call this function to get the result you want.
__`_@idio/vscode-jsdoc-1.Config`__: Options for the program.
| Name | Type | Description | Default |
| --------- | ---------------- | ----------------- | ------- |
| shouldRun | boolean | A boolean option. | `true` |
| __text*__ | string | A text to return. | - |
```js
/* alanode example/ */
import vscodeJsdoc_1 from '@idio/vscode-jsdoc-1'
(async () => {
const res = await vscodeJsdoc_1({
text: 'example',
})
console.log(res)
})()
```
```
example
```
## Copyright
(c) [Idio][1] 2019
[1]: https://idio.cc
