Skip to content

feat: adds napi/create-bool #4889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
229 changes: 229 additions & 0 deletions lib/node_modules/@stdlib/napi/create-bool/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
<!--

@license Apache-2.0

Copyright (c) 2025 The Stdlib Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-->

# create_bool

> Convert a boolean value to a Node-API value.

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- Package usage documentation. -->

<section class="usage">

## Usage

```javascript
var headerDir = require( '@stdlib/napi/create-bool' );
```

#### headerDir

Absolute file path for the directory containing header files for C APIs.

```javascript
var dir = headerDir;
// returns <string>
```

</section>

<!-- /.usage -->

<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- Package usage examples. -->

<section class="examples">

## Examples

```javascript
var headerDir = require( '@stdlib/napi/create-bool' );

console.log( headerDir );
// => <string>
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/napi/create_bool.h"
```

#### stdlib_napi_create_bool( env, value, \*out )

Converts a boolean value to a Node-API value.

```c
#include "stdlib/napi/create_bool.h"
#include <node_api.h>
#include <stdbool.h>

static napi_value addon( napi_env env, napi_callback_info info ) {

// ...

napi_value value;
napi_status status = stdlib_napi_create_bool( env, true, &value );
assert( status == napi_ok );
if ( err != NULL ) {
assert( napi_throw( env, err ) == napi_ok );
return NULL;
}

// ...
}
```

The function accepts the following arguments:

- **env**: `[in] napi_env` environment under which the function is invoked.
- **value**: `[in] bool` boolean value.
- **out**: `[out] napi_value*` destination for storing output value.

```c
napi_status stdlib_napi_create_bool( const napi_env env, const bool value, napi_value *out );
```

The function returns a `napi_status` status code indicating success or failure (returns `napi_ok` if success).

#### STDLIB_NAPI_CREATE_BOOL( env, expression, name )

Macro for converting a boolean value to a Node-API value.

```c
#include "stdlib/napi/create_bool.h"
#include "stdlib/napi/argv_bool.h"
#include "stdlib/napi/argv.h"
#include <node_api.h>
#include <stdbool.h>

static bool fcn( const bool v ) {
return v;
}

// ...

static napi_value addon( napi_env env, napi_callback_info info ) {
// Retrieve add-on callback arguments:
STDLIB_NAPI_ARGV( env, info, argv, argc, 1 );

// Convert the first argument to a C type:
STDLIB_NAPI_ARGV_BOOL( env, value, argv, 0 );

// ...

// Convert a value having a C type to a Node-API value:
STDLIB_NAPI_CREATE_BOOL( env, fcn( value ), out );

return out;
}
```

The macro expects the following arguments:

- **env**: environment under which the callback is invoked.
- **expression**: expression returning a boolean value.
- **name**: output variable name.

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="references">

</section>

<!-- /.references -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

</section>

<!-- /.links -->
Loading
Loading