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

@useoptic/optic-engine-native

v10.3.0

Published

The highest performance way to call the Optic engine by providing native ways to call the Optic engine, enabling concurrency through threads:

Downloads

13

Readme

Native interface to Optic Engine

The highest performance way to call the Optic engine by providing native ways to call the Optic engine, enabling concurrency through threads:

  • CLI binary. Pre-built binaries for all supported versions are published for every published version of Optic.
  • Node.js library, which installs a pre-built binary upon installation as an npm package and spawns a new process for each call to it. Typescript definitions come included.

Development Dependencies

This project is written in Rust. To install all the basics you need (Rust compiler + Cargo) to make a build, the recommended way is to use the official Rust Up project. On Linux or macOS, that comes down to running (if you trust executing curled shell scripts):

$ curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh

If you're on Windows or want to know more about how to get the basic Rust toolchain in place, this Installation Chapter of the Official Rust Book.

Building the binary and accompanying Node.js

The recommended way to build a development binary is to use the following commands from the repository root:

$ task workspaces:build

Usage

To use the CLI directly, in repository root run:

$ cargo run

error: The following required arguments were not provided:
    <SPEC_PATH>

USAGE:
    optic_diff [FLAGS] <SPEC_PATH> [SUBCOMMAND]

For more information try --help

For use in Node.js, install the npm package and import it:

// CommonJS
const OpticEngine = require('@useoptic/optic-engine-native');

// ESM / Typescript
import * as OpticEngine from '@useoptic/optic-engine-native';

Running end-to-end

To test the development binary packages through the Optic product, as opposed to running the automated tests, use the standalone cli-server:

$ task workspaces:build
$ node --inspect-brk workspaces/cli-server/build/standalone-server.js /path/to/your/api/project

Or, run the apidev start command made available through source sourceme.sh from the repository root, which runs the cli-server as a daemon. Because it is a daemon, you may need to restart it via apidev daemon:stop to pick up the latest changes:

$ source sourceme.sh
$ apidev start