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

njs-types

v0.8.2

Published

TypeScript definitions for njs scripting language and nginx js modules.

Downloads

10,921

Readme

TypeScript definitions for njs

This package contains type definitions for njs – NGINX JavaScript.

Usage

Install njs-types from the npm registry into your project:

# using npm:
npm install --save-dev njs-types
# or using yarn:
yarn add --dev njs-types

njs-types provides three entry points with global declarations for each of njs environments:

  • njs_shell.d.ts – njs shell
  • ngx_http_js_module.d.ts – NGINX JS HTTP Module
  • ngx_stream_js_module.d.ts – NGINX JS Stream Module

You can either reference them using triple-slash directive at top of your .ts files (adjust path to point into your project’s node_modules):

/// <reference path="./node_modules/njs-types/ngx_http_js_module.d.ts" />

or include them using the files flag in your tsconfig.json, for example:

{
  "compilerOptions": {
    "target": "ES5",
    "module": "es2015",
    "lib": [
      "ES2015",
      "ES2016.Array.Include",
      "ES2017.Object",
      "ES2017.String"
    ],
    "outDir": "./lib",
    "downlevelIteration": true,

    "strict": true,
    "noImplicitAny": true,
    "strictNullChecks": true,
    "strictFunctionTypes": true,
    "strictBindCallApply": true,
    "strictPropertyInitialization": true,
    "noImplicitThis": true,
    "alwaysStrict": true,

    "moduleResolution": "node",

    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
  },
  "include": [
    "./src",
  ],
  "files": [
    "./node_modules/njs-types/ngx_http_js_module.d.ts",
  ],
}

Versions

njs-types is typically being released together with njs. Their major and minor release numbers (the first two numbers) are always aligned, but the patch version (the third number) may differ. That's because njs-types may be updated between njs releases and in such case the patch version is incremented.

It's the same strategy as used in DefinitelyTyped. The reason is that npmjs enforces SemVer which doesn't allow four-part version number nor provide post-release suffixes.

You can find from which commit the package was built in file COMMITHASH inside the published package. It contains global revision id in the upstream repository https://hg.nginx.org/njs/ (Mercurial).