82 lines
3.7 KiB
Markdown
82 lines
3.7 KiB
Markdown
|
<a name="module_napi-build-utils"></a>
|
||
|
|
|
||
|
|
## napi-build-utils
|
||
|
|
A set of utilities to assist developers of tools that build
|
||
|
|
[N-API](https://nodejs.org/api/n-api.html#n_api_n_api) native add-ons.
|
||
|
|
|
||
|
|
The main repository can be found
|
||
|
|
[here](https://github.com/inspiredware/napi-build-utils#napi-build-utils).
|
||
|
|
|
||
|
|
|
||
|
|
* [napi-build-utils](#module_napi-build-utils)
|
||
|
|
* [.isNapiRuntime(runtime)](#module_napi-build-utils.isNapiRuntime) ⇒ <code>boolean</code>
|
||
|
|
* [.isSupportedVersion(napiVersion)](#module_napi-build-utils.isSupportedVersion) ⇒ <code>boolean</code>
|
||
|
|
* [.logUnsupportedVersion(napiVersion, log)](#module_napi-build-utils.logUnsupportedVersion)
|
||
|
|
* [.getBestNapiBuildVersion()](#module_napi-build-utils.getBestNapiBuildVersion) ⇒ <code>number</code> \| <code>undefined</code>
|
||
|
|
* [.getNapiBuildVersions()](#module_napi-build-utils.getNapiBuildVersions) ⇒ <code>Array.<string></code>
|
||
|
|
* [.getNapiVersion()](#module_napi-build-utils.getNapiVersion) ⇒ <code>string</code> \| <code>undefined</code>
|
||
|
|
|
||
|
|
<a name="module_napi-build-utils.isNapiRuntime"></a>
|
||
|
|
|
||
|
|
### napi-build-utils.isNapiRuntime(runtime) ⇒ <code>boolean</code>
|
||
|
|
Implements a consistent name of `napi` for N-API runtimes.
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>napi-build-utils</code>](#module_napi-build-utils)
|
||
|
|
|
||
|
|
| Param | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| runtime | <code>string</code> | The runtime string. |
|
||
|
|
|
||
|
|
<a name="module_napi-build-utils.isSupportedVersion"></a>
|
||
|
|
|
||
|
|
### napi-build-utils.isSupportedVersion(napiVersion) ⇒ <code>boolean</code>
|
||
|
|
Determines whether the specified N-API version is supported
|
||
|
|
by both the currently running Node instance and the package.
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>napi-build-utils</code>](#module_napi-build-utils)
|
||
|
|
|
||
|
|
| Param | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| napiVersion | <code>string</code> | The N-API version to check. |
|
||
|
|
|
||
|
|
<a name="module_napi-build-utils.logUnsupportedVersion"></a>
|
||
|
|
|
||
|
|
### napi-build-utils.logUnsupportedVersion(napiVersion, log)
|
||
|
|
Issues a warning to the supplied log if the N-API version is not supported
|
||
|
|
by the current Node instance or if the N-API version is not supported
|
||
|
|
by the package.
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>napi-build-utils</code>](#module_napi-build-utils)
|
||
|
|
|
||
|
|
| Param | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| napiVersion | <code>string</code> | The N-API version to check. |
|
||
|
|
| log | <code>Object</code> | The log object to which the warnings are to be issued. Must implement the `warn` method. |
|
||
|
|
|
||
|
|
<a name="module_napi-build-utils.getBestNapiBuildVersion"></a>
|
||
|
|
|
||
|
|
### napi-build-utils.getBestNapiBuildVersion() ⇒ <code>number</code> \| <code>undefined</code>
|
||
|
|
Returns the best N-API version to build given the highest N-API
|
||
|
|
version supported by the current Node instance and the N-API versions
|
||
|
|
supported by the package, or undefined if a suitable N-API version
|
||
|
|
cannot be determined.
|
||
|
|
|
||
|
|
The best build version is the greatest N-API version supported by
|
||
|
|
the package that is less than or equal to the highest N-API version
|
||
|
|
supported by the current Node instance.
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>napi-build-utils</code>](#module_napi-build-utils)
|
||
|
|
<a name="module_napi-build-utils.getNapiBuildVersions"></a>
|
||
|
|
|
||
|
|
### napi-build-utils.getNapiBuildVersions() ⇒ <code>Array.<string></code>
|
||
|
|
Returns an array of N-API versions supported by the package.
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>napi-build-utils</code>](#module_napi-build-utils)
|
||
|
|
<a name="module_napi-build-utils.getNapiVersion"></a>
|
||
|
|
|
||
|
|
### napi-build-utils.getNapiVersion() ⇒ <code>string</code> \| <code>undefined</code>
|
||
|
|
Returns the highest N-API version supported by the current node instance
|
||
|
|
or undefined if N-API is not supported.
|
||
|
|
|
||
|
|
**Kind**: static method of [<code>napi-build-utils</code>](#module_napi-build-utils)
|