Big News: Socket Selected for OpenAI's Cybersecurity Grant Program.Details →
token-types
Advanced tools
token-types - npm Package Compare versions
+1
-0
@@ -560,1 +560,2 @@ "use strict"; | ||
| exports.writeIntBE = writeIntBE; | ||
| //# sourceMappingURL=index.js.map |
+35
-17
| { | ||
| "name": "token-types", | ||
| "version": "1.0.1", | ||
| "version": "1.0.2", | ||
| "description": "Common token types for decoding and encoding binairy values", | ||
@@ -10,13 +10,13 @@ "author": { | ||
| "scripts": { | ||
| "clean": "del-cli lib/**/*.js lib/**/*.js.map lib/**/*.d.ts test/**/*.d.ts test/**/*.js test/**/*.js.map .nyc_output", | ||
| "build": "npm run compile", | ||
| "compile-src": "tsc -p src", | ||
| "compile-src": "tsc -p lib", | ||
| "compile-test": "tsc -p test", | ||
| "compile": "npm run compile-src && npm run compile-test", | ||
| "prepare": "npm run compile", | ||
| "lint-ts": "tslint 'src/**/*.ts' --exclude 'src/**/*.d.ts' 'test/**/*.ts' --exclude 'test/**/*.d.ts'", | ||
| "lint-ts": "tslint 'lib/**/*.ts' --exclude 'lib/**/*.d.ts' 'test/**/*.ts' --exclude 'test/**/*.d.ts'", | ||
| "lint-md": "remark -u preset-lint-recommended .", | ||
| "lint": "npm run lint-ts && npm run lint-md", | ||
| "test": "mocha --require ts-node/register test", | ||
| "cover-test": "nyc npm run test", | ||
| "coveralls": "npm run cover-test && nyc report --reporter=text-lcov | coveralls" | ||
| "test": "mocha --require ts-node/register --require source-map-support/register --full-trace --recursive test/*.ts", | ||
| "test-coverage": "nyc npm run test", | ||
| "coveralls": "npm run test-coverage && nyc report --reporter=text-lcov | coveralls" | ||
| }, | ||
@@ -37,14 +37,16 @@ "engines": { | ||
| "devDependencies": { | ||
| "@types/chai": "^4.1.6", | ||
| "@types/chai": "^4.2.0", | ||
| "@types/mocha": "^5.2.5", | ||
| "@types/node": "^10.12.0", | ||
| "@types/node": "^12.7.2", | ||
| "chai": "^4.2.0", | ||
| "coveralls": "^3.0.2", | ||
| "mocha": "^5.2.0", | ||
| "nyc": "^13.1.0", | ||
| "remark-cli": "^6.0.0", | ||
| "remark-preset-lint-recommended": "^3.0.2", | ||
| "ts-node": "^7.0.1", | ||
| "tslint": "^5.11.0", | ||
| "typescript": "^3.1.3" | ||
| "coveralls": "^3.0.6", | ||
| "del-cli": "^2.0.0", | ||
| "mocha": "^6.2.0", | ||
| "nyc": "^14.1.1", | ||
| "remark-cli": "^7.0.0", | ||
| "remark-preset-lint-recommended": "^3.0.3", | ||
| "source-map-support": "^0.5.13", | ||
| "ts-node": "^8.3.0", | ||
| "tslint": "^5.18.0", | ||
| "typescript": "^3.5.3" | ||
| }, | ||
@@ -56,3 +58,19 @@ "dependencies": {}, | ||
| ] | ||
| }, | ||
| "nyc": { | ||
| "exclude": [ | ||
| "test/**/*.ts", | ||
| "lib/**/*.js" | ||
| ], | ||
| "extension": [ | ||
| ".ts" | ||
| ], | ||
| "sourceMap": true, | ||
| "instrument": true, | ||
| "reporter": [ | ||
| "lcov", | ||
| "text" | ||
| ], | ||
| "report-dir": "coverage" | ||
| } | ||
| } |
+5
-4
@@ -7,2 +7,3 @@ [](https://travis-ci.org/Borewit/token-types) | ||
| [](https://www.codacy.com/app/Borewit/token-types?utm_source=github.com&utm_medium=referral&utm_content=Borewit/token-types&utm_campaign=Badge_Grade) | ||
| [](https://deepscan.io/dashboard#view=project&tid=5165&pid=6940&bid=61852) | ||
| [](https://snyk.io/test/github/Borewit/token-types?targetFile=package.json) | ||
@@ -34,7 +35,7 @@ | ||
| Complex tokens can be added, which makes very suitable for reading binary files or network messages: | ||
| ```JavaScript | ||
| public static ExtendedHeader: Token.IGetToken<IExtendedHeader> = { | ||
| ```javascript | ||
| ExtendedHeader = { | ||
| len: 10, | ||
| get: (buf, off): IExtendedHeader => { | ||
| get: (buf, off) => { | ||
| return { | ||
@@ -52,2 +53,2 @@ // Extended header size | ||
| }; | ||
| ``` | ||
| ``` |
-24
| language: node_js | ||
| node_js: | ||
| - "6" | ||
| - "7" | ||
| - "8" | ||
| - "9" | ||
| - "10" | ||
| - "11" | ||
| install: | ||
| - yarn install | ||
| - yarn run compile | ||
| script: | ||
| - yarn run lint-ts | ||
| - yarn run lint-md | ||
| - yarn run test | ||
| jobs: | ||
| include: | ||
| - stage: after_success | ||
| script: | ||
| - yarn install | ||
| - yarn run compile | ||
| - yarn run coveralls | ||
| node_js: 9 |
-160
| /// <reference types="node" /> | ||
| export interface IGetToken<T> { | ||
| /** | ||
| * Length in bytes of encoded value | ||
| */ | ||
| len: number; | ||
| /** | ||
| * Decode value from buffer at offset | ||
| * @param buf Buffer to read the decoded value from | ||
| * @param off Decode offset | ||
| */ | ||
| get(buf: Buffer, off: number): T; | ||
| } | ||
| export interface IToken<T> extends IGetToken<T> { | ||
| /** | ||
| * Encode value to buffer | ||
| * @param buffer Buffer to write the encoded value to | ||
| * @param offset Buffer write offset | ||
| * @param value Value to decode of type T | ||
| * @param flush ToDo | ||
| */ | ||
| put(buffer: Buffer, offset: number, value: T, flush?: IFlush): number; | ||
| } | ||
| export declare type IFlush = (b: Buffer, o: number) => void; | ||
| /** | ||
| * 8-bit unsigned integer | ||
| */ | ||
| export declare const UINT8: IToken<number>; | ||
| /** | ||
| * 16-bit unsigned integer, Little Endian byte order | ||
| */ | ||
| export declare const UINT16_LE: IToken<number>; | ||
| /** | ||
| * 16-bit unsigned integer, Big Endian byte order | ||
| */ | ||
| export declare const UINT16_BE: IToken<number>; | ||
| /** | ||
| * 24-bit unsigned integer, Little Endian byte order | ||
| */ | ||
| export declare const UINT24_LE: IToken<number>; | ||
| /** | ||
| * 24-bit unsigned integer, Big Endian byte order | ||
| */ | ||
| export declare const UINT24_BE: IToken<number>; | ||
| /** | ||
| * 32-bit unsigned integer, Little Endian byte order | ||
| */ | ||
| export declare const UINT32_LE: IToken<number>; | ||
| /** | ||
| * 32-bit unsigned integer, Big Endian byte order | ||
| */ | ||
| export declare const UINT32_BE: IToken<number>; | ||
| /** | ||
| * 8-bit signed integer | ||
| */ | ||
| export declare const INT8: IToken<number>; | ||
| /** | ||
| * 16-bit signed integer, Big Endian byte order | ||
| */ | ||
| export declare const INT16_BE: IToken<number>; | ||
| /** | ||
| * 16-bit signed integer, Little Endian byte order | ||
| */ | ||
| export declare const INT16_LE: IToken<number>; | ||
| /** | ||
| * 24-bit signed integer, Little Endian byte order | ||
| */ | ||
| export declare const INT24_LE: IToken<number>; | ||
| /** | ||
| * 24-bit signed integer, Big Endian byte order | ||
| */ | ||
| export declare const INT24_BE: IToken<number>; | ||
| /** | ||
| * 32-bit signed integer, Big Endian byte order | ||
| */ | ||
| export declare const INT32_BE: IToken<number>; | ||
| /** | ||
| * 32-bit signed integer, Big Endian byte order | ||
| */ | ||
| export declare const INT32_LE: IToken<number>; | ||
| /** | ||
| * 64-bit unsigned integer, Little Endian byte order | ||
| */ | ||
| export declare const UINT64_LE: IToken<number>; | ||
| /** | ||
| * 64-bit signed integer, Little Endian byte order | ||
| */ | ||
| export declare const INT64_LE: IToken<number>; | ||
| /** | ||
| * 64-bit unsigned integer, Big Endian byte order | ||
| */ | ||
| export declare const UINT64_BE: IToken<number>; | ||
| /** | ||
| * 64-bit signed integer, Big Endian byte order | ||
| */ | ||
| export declare const INT64_BE: IToken<number>; | ||
| /** | ||
| * Ignore a given number of bytes | ||
| */ | ||
| export declare class IgnoreType implements IGetToken<Buffer> { | ||
| len: number; | ||
| /** | ||
| * @param len number of bytes to ignore | ||
| */ | ||
| constructor(len: number); | ||
| get(buf: Buffer, off: number): Buffer; | ||
| } | ||
| export declare class BufferType implements IGetToken<Buffer> { | ||
| len: number; | ||
| constructor(len: number); | ||
| get(buf: Buffer, off: number): Buffer; | ||
| } | ||
| /** | ||
| * Consume a fixed number of bytes from the stream and return a string with a specified encoding. | ||
| */ | ||
| export declare class StringType implements IGetToken<string> { | ||
| len: number; | ||
| encoding: string; | ||
| constructor(len: number, encoding: string); | ||
| get(buf: Buffer, off: number): string; | ||
| } | ||
| /** | ||
| * ANSI Latin 1 String | ||
| * Using windows-1252 / ISO 8859-1 decoding | ||
| */ | ||
| export declare class AnsiStringType implements IGetToken<string> { | ||
| len: number; | ||
| private static windows1252; | ||
| private static decode; | ||
| private static inRange; | ||
| private static codePointToString; | ||
| private static singleByteDecoder; | ||
| constructor(len: number); | ||
| get(buf: Buffer, off?: number): string; | ||
| } | ||
| /** | ||
| * Best effort approach to write 64 but signed integer, little endian. | ||
| * Note that JavasScript is limited to 2^53 - 1 bit. | ||
| */ | ||
| export declare function writeIntLE(buf: Buffer, value: number, offset: number, byteLength: number): number; | ||
| /** | ||
| * Best effort approach to read up to 64 bit unsigned integer, big endian. | ||
| * Note that JavasScript is limited to 2^53 - 1 bit. | ||
| */ | ||
| export declare function readUIntBE(buf: Buffer, offset: number, byteLength: number): number; | ||
| /** | ||
| * Best effort approach to write up to 64 bit unsigned integer, big endian. | ||
| * Note that JavasScript is limited to 2^53 - 1 bit. | ||
| */ | ||
| export declare function writeUIntBE(buf: Buffer, value: number, offset: number, byteLength: number): number; | ||
| /** | ||
| * Best effort approach to read 64 but signed integer, big endian. | ||
| * Note that JavasScript is limited to 2^53 - 1 bit. | ||
| */ | ||
| export declare function readIntBE(buf: Buffer, offset: number, byteLength: number): number; | ||
| /** | ||
| * Best effort approach to write 64 but signed integer, big endian. | ||
| * Note that JavasScript is limited to 2^53 - 1 bit. | ||
| */ | ||
| export declare function writeIntBE(buf: Buffer, value: number, offset: number, byteLength: number): number; |
-26
| { | ||
| "extends": "tslint:latest", | ||
| "rules": { | ||
| "curly": false, | ||
| "max-classes-per-file": [false], | ||
| "semicolon": [true, "always", "ignore-interfaces"], | ||
| "quotemark": [false, "double", "avoid-escape"], | ||
| "no-bitwise": false, | ||
| "trailing-comma": [true, {"multiline": "never", "singleline": "never"}], | ||
| "object-literal-key-quotes": [true, "as-needed"], | ||
| "variable-name": [true, "ban-keywords"], | ||
| "object-literal-sort-keys": [false], | ||
| "max-line-length": false, | ||
| "switch-default": false, | ||
| "prefer-for-of": false, | ||
| "ordered-imports": false, | ||
| "forin": false, | ||
| "no-implicit-dependencies": [true, "dev"], | ||
| "no-conditional-assignment": false | ||
| }, | ||
| "jsRules": { | ||
| "curly": false | ||
| }, | ||
| "rulesDirectory": [ | ||
| ] | ||
| } |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
Deprecated
MaintenanceThe maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
52
4%Worsened metrics
- Total package byte prevSize
20775
-93.57%- Dev dependency count
14
16.67%- Number of package files
4
-55.56%- Lines of code
559
-24.87%- Number of medium maintenance alerts
1
Infinity%No dependency changes