itk-compress-stringify

v0.3.0

Zstandard compression and decompression and base64 encoding and decoding in WebAssembly. For more information about how to use this package see README

Latest version published 1 year ago

License: Apache-2.0

NPM

GitHub

Package Health Score

53 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.2.0	\|	01/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.0	\|	01/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.0	\|	01/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (0)

GitHub Stars: 172
Forks: 45
Contributors: -

Direct Usage Popularity

The npm package itk-compress-stringify receives a total of 0 downloads a week. As such, we scored itk-compress-stringify popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package itk-compress-stringify, we found that it has been starred 172 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 77
Open PR: 23
Last Release: 1 year ago
Last Commit: 2 months ago

Further analysis of the maintenance status of itk-compress-stringify based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for itk-compress-stringify is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 1 year
Dependencies: 1 Direct
Versions: 4
Install Size: 2.72 MB
Dist-tags: 1
# of Files: 77
Maintainers: 1
TS Typings: No

itk-compress-stringify has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

itk-compress-stringify

Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.

Example

Documentation

Installation

npm install itk-compress-stringify

Usage

Browser interface

Import:

import {
  compressStringify,
  parseStringDecompress,
  setPipelinesBaseUrl,
  getPipelinesBaseUrl,
  setPipelineWorkerUrl,
  getPipelineWorkerUrl,
} from "itk-compress-stringify"

Functions

compressStringify

Given a binary, compress and optionally base64 encode.

async function compressStringify(
  webWorker: null | Worker,
  input: Uint8Array,
  options: CompressStringifyOptions = {}
) : Promise

Parameter	Type	Description
`input`	Uint8Array	Input binary

CompressStringifyOptions interface:

Property	Type	Description
`stringify`	boolean	Stringify the output
`compressionLevel`	number	Compression level, typically 1-9
`dataUrlPrefix`	string	dataURL prefix

CompressStringifyResult interface:

Property	Type	Description
webWorker	Worker	WebWorker used for computation
`output`	Uint8Array	Output compressed binary

parseStringDecompress

Given a binary or string produced with compressStringify, decompress and optionally base64 decode.

async function parseStringDecompress(
  webWorker: null | Worker,
  input: Uint8Array,
  options: ParseStringDecompressOptions = {}
) : Promise

Parameter	Type	Description
`input`	Uint8Array	Compressed input

ParseStringDecompressOptions interface:

Property	Type	Description
`parseString`	boolean	Parse the input string before decompression

ParseStringDecompressResult interface:

Property	Type	Description
webWorker	Worker	WebWorker used for computation
`output`	Uint8Array	Output decompressed binary

setPipelinesBaseUrl

Set base URL for WebAssembly assets when vendored.

function setPipelinesBaseUrl(
  baseUrl: string | URL
) : void

getPipelinesBaseUrl

Get base URL for WebAssembly assets when vendored.

function getPipelinesBaseUrl() : string | URL

setPipelineWorkerUrl

Set base URL for the itk-wasm pipeline worker script when vendored.

function setPipelineWorkerUrl(
  baseUrl: string | URL
) : void

getPipelineWorkerUrl

Get base URL for the itk-wasm pipeline worker script when vendored.

function getPipelineWorkerUrl() : string | URL

Node interface

Import:

import {
  compressStringifyNode,
  parseStringDecompressNode,
} from "itk-compress-stringify"

compressStringifyNode

Given a binary, compress and optionally base64 encode.

async function compressStringifyNode(
  input: Uint8Array,
  options: CompressStringifyOptions = {}
) : Promise

Parameter	Type	Description
`input`	Uint8Array	Input binary

CompressStringifyNodeOptions interface:

Property	Type	Description
`stringify`	boolean	Stringify the output
`compressionLevel`	number	Compression level, typically 1-9
`dataUrlPrefix`	string	dataURL prefix

CompressStringifyNodeResult interface:

Property	Type	Description
`output`	Uint8Array	Output compressed binary

parseStringDecompressNode

Given a binary or string produced with CompressedStringify, decompress and optionally base64 decode.

async function parseStringDecompressNode(
  input: Uint8Array,
  options: ParseStringDecompressOptions = {}
) : Promise

Parameter	Type	Description
`input`	Uint8Array	Compressed input

ParseStringDecompressNodeOptions interface:

Property	Type	Description
`parseString`	boolean	Parse the input string before decompression

ParseStringDecompressNodeResult interface:

Property	Type	Description
`output`	Uint8Array	Output decompressed binary

itk-compress-stringify dependencies

itk-wasm

itk-compress-stringify development dependencies

@rollup/plugin-commonjs @rollup/plugin-json @rollup/plugin-node-resolve @rollup/plugin-terser @rollup/plugin-typescript @types/node ava cypress rollup rollup-plugin-copy rollup-plugin-ignore rollup-plugin-polyfill-node start-server-and-test typescript vite vite-plugin-static-copy

FAQs

What is itk-compress-stringify?

Zstandard compression and decompression and base64 encoding and decoding in WebAssembly. Visit Snyk Advisor to see a full health score report for itk-compress-stringify, including popularity, security, maintenance & community analysis.

Is itk-compress-stringify popular?

We’re still processing downloads data for the npm package itk-compress-stringify. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is itk-compress-stringify well maintained?

We found indications that itk-compress-stringify is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is itk-compress-stringify safe to use?

While scanning the latest version of itk-compress-stringify, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 13 April-2024, at 04:09 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (0)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

itk-compress-stringify

Installation

Usage

Browser interface

Functions

compressStringify

parseStringDecompress

setPipelinesBaseUrl

getPipelinesBaseUrl

setPipelineWorkerUrl

getPipelineWorkerUrl

Node interface

compressStringifyNode

parseStringDecompressNode

itk-compress-stringify dependencies

itk-compress-stringify development dependencies

FAQs

What is itk-compress-stringify?

Is itk-compress-stringify popular?

Is itk-compress-stringify well maintained?

Is itk-compress-stringify safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues