API Reference
This section provides detailed API documentation.
Core API
myFunction()
Main function that does something useful.
js
import { myFunction } from 'my-package'
myFunction({
param1: 'value',
param2: true
})Parameters
| Name | Type | Description |
|---|---|---|
| param1 | string | Description of param1 |
| param2 | boolean | Description of param2 |
Returns
Returns a Promise<void>.