Detalhes do pacote

@stdlib/napi-export

stdlib-js17.8kApache-2.00.2.2

C utilities for registering Node-API modules.

stdlib, napi, native, addon

readme (leia-me)

<summary> About stdlib... </summary>

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Node-API Exports

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

C utilities for registering Node-API modules.

## Installation bash npm install @stdlib/napi-export
## Usage javascript var headerDir = require( '@stdlib/napi-export' ); #### headerDir Absolute file path for the directory containing header files for C APIs. javascript var dir = headerDir; // returns <string>
## Examples javascript var headerDir = require( '@stdlib/napi-export' ); console.log( headerDir ); // => <string>

## C APIs
### Usage c #include "stdlib/napi/export.h" #### STDLIB_NAPI_MODULE_EXPORT_FCN( name ) Macro for registering a Node-API module which exports a function. c #include <node_api.h> // ... static napi_value addon( napi_env env, napi_callback_info info ) { // ... } // ... // Register a Node-API module: STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) The macro expects the following arguments: - name: name of the C function to export. When used, this macro should be used instead of NAPI_MODULE. The macro includes NAPI_MODULE, thus ensuring Node-API module registration.

* ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/napi-export.svg [npm-url]: https://npmjs.org/package/@stdlib/napi-export [test-image]: https://github.com/stdlib-js/napi-export/actions/workflows/test.yml/badge.svg?branch=v0.2.2 [test-url]: https://github.com/stdlib-js/napi-export/actions/workflows/test.yml?query=branch:v0.2.2 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/napi-export/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/napi-export?branch=main [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im [stdlib]: https://github.com/stdlib-js/stdlib [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/napi-export/main/LICENSE