https://github.com/idiocc/hot-reload-article
An article about hot reload.
https://github.com/idiocc/hot-reload-article
hot-reload idio
Last synced: about 1 year ago
JSON representation
An article about hot reload.
- Host: GitHub
- URL: https://github.com/idiocc/hot-reload-article
- Owner: idiocc
- License: agpl-3.0
- Created: 2020-03-03T22:37:49.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-03T22:38:21.000Z (over 6 years ago)
- Last Synced: 2025-02-15T07:49:00.572Z (over 1 year ago)
- Topics: hot-reload, idio
- Language: JavaScript
- Size: 57.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/hot-reload-article
[](https://www.npmjs.com/package/@idio/hot-reload-article)
`@idio/hot-reload-article` is An article about hot reload.
```sh
yarn add @idio/hot-reload-article
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`async hotReloadArticle(config: !Config): string`](#async-mynewpackageconfig-config-string)
* [`Config`](#type-config)
- [CLI](#cli)
- [Copyright & License](#copyright--license)
## API
The package is available by importing its default function:
```js
import hotReloadArticle from '@idio/hot-reload-article'
```
## async hotReloadArticle(
`config: !Config,`
): string
An article about hot reload.
- 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. | - |
```js
import hotReloadArticle from '@idio/hot-reload-article'
(async () => {
const res = await hotReloadArticle({
text: 'example',
})
console.log(res)
})()
```
```
@idio/hot-reload-article called with example
example
```
## Copyright & License
GNU Affero General Public License v3.0
© Idio 2020
