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

@regulaforensics/document-reader-typings

v7.4.210

Published

Document Reader API typings

Downloads

5,021

Readme

document-reader-typings

TypeScript definitions for Regula Document Reader SDK

Installation

npm install --save @regulaforensics/document-reader-typings

Setup tests

  1. Copy .env.example to .env and set all variables (or set environment variables manually, if some variables are not set, tests for this functionality will be skipped)
  2. Run node tools/inspect-test-dirs-configuration.js to check if all test directories are configured correctly
  3. Run npm run test

Manual check of separate file

  1. Build project with npm run build
  2. Run node tools/analize-json.js --f <path-to-file>

Output when file is invalid:

Errors: {
  "ContainerList.List.0.light": [
    "light must be a number",
    "light must be one of the following values: 0, 6, 24, 128"
  ]
}

Output when file is valid:

File is valid

Difference check

Option -d allows to run check a difference between validated file and original file: If there will be any difference, it will be printed to console. For example:

Differences: [
  {
    "kind": "change occurred within an array",
    "path": "ContainerList.List.1"
  },
  {
    "kind": "property/element was deleted",
    "path": "TransactionInfo.Version"
  },
  {
    "kind": "newly added property/element",
    "path": "log"
  }
]

You can also change the file .excluded to exclude some properties from difference check. File is located in root of project. This file exclude path for analyze-json tool and for tests.