npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@stdlib/assert-napi-status-ok

v0.2.2

Published

C utilities for asserting that a Node-API call returns an "ok" status.

Downloads

9,162

Readme

ok status

NPM version Build Status Coverage Status

C utilities for asserting that a Node-API call returns an "ok" status.

Installation

npm install @stdlib/assert-napi-status-ok

Usage

var headerDir = require( '@stdlib/assert-napi-status-ok' );

headerDir

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

var dir = headerDir;
// returns <string>

Examples

var headerDir = require( '@stdlib/assert-napi-status-ok' );

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

C APIs

Usage

#include "stdlib/assert/napi/status_ok.h"

STDLIB_ASSERT_NAPI_STATUS_OK_RET_VOID( env, call, message )

Macro for asserting that a Node-API API call returns an "ok" status.

#include <node_api.h>

static void foo( const napi_env env, const napi_value value, double *out ) {
    // ...

    STDLIB_ASSERT_NAPI_STATUS_OK_RET_VOID( env, napi_get_value_double( env, value, out ), "" )

    // ...

    return;
}

The macro expects the following arguments:

  • env: environment under which the function is invoked.
  • call: expression which returns a Node-API status.
  • message: error message.

If a status is not "ok", an exception is raised and void returned.

STDLIB_ASSERT_NAPI_STATUS_OK_RET_NULL( env, call, message )

Macro for asserting that a Node-API API call returns an "ok" status.

#include <node_api.h>

static napi_value foo( const napi_env env, const napi_value value, double *out ) {
    // ...

    STDLIB_ASSERT_NAPI_STATUS_OK_RET_NULL( env, napi_get_value_double( env, value, out ), "" )

    // ...

    return NULL;
}

The macro expects the following arguments:

  • env: environment under which the function is invoked.
  • call: expression which returns a Node-API status.
  • message: error message.

If a status is not "ok", an exception is raised and NULL returned.

STDLIB_ASSERT_NAPI_STATUS_OK_RET_VALUE( env, call, message, value )

Macro for asserting that a Node-API API call returns an "ok" status.

#include <node_api.h>

static double foo( const napi_env env, const napi_value value ) {
    // ...

    double *out;
    STDLIB_ASSERT_NAPI_STATUS_OK_RET_VALUE( env, napi_get_value_double( env, value, out ), "", 0.0/0.0 )

    // ...

    return out;
}

The macro expects the following arguments:

  • env: environment under which the function is invoked.
  • call: expression which returns a Node-API status.
  • message: error message.
  • value: return value.

If a status is not "ok", an exception is raised and the value specified by value returned.


Notice

This package is part of 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, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.