Skip to content

Commit 8ac6086

Browse files
Move built-in compression to plugin
1 parent c6869ef commit 8ac6086

File tree

12 files changed

+233
-216
lines changed

12 files changed

+233
-216
lines changed

defs/classes/CoderTools.d.ts

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
1-
/// <reference types="node" />
2-
export declare class CoderTools {
3-
static BASE_ALPHABETS: {
4-
BASE16: string;
5-
BASE36: string;
6-
BASE58: string;
7-
BASE62: string;
8-
BASE66: string;
9-
};
10-
static isBuffer(what: any): boolean;
11-
static makeWBuffer(cb: (arg: Buffer) => void, length: number): Buffer;
12-
static toBuffer(what: string | Buffer, ascii?: boolean): Buffer;
13-
static baseXEncode(what: string | Buffer, base: string, asAscii?: boolean): string;
14-
static baseXDecode(what: string, base: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
15-
static base16Encode(what: string | Buffer, asAscii?: boolean): string;
16-
static base32Encode(what: string | Buffer, asAscii?: boolean): string;
17-
static base36Encode(what: string | Buffer, asAscii?: boolean): string;
18-
static base58Encode(what: string | Buffer, asAscii?: boolean): string;
19-
static base62Encode(what: string | Buffer, asAscii?: boolean): string;
20-
static base64Encode(what: string | Buffer, asAscii?: boolean): string;
21-
static base66Encode(what: string | Buffer, asAscii?: boolean): string;
22-
static base16Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
23-
static base32Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer | Uint8Array;
24-
static base36Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
25-
static base58Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer | Uint8Array;
26-
static base62Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
27-
static base64Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer | Uint8Array;
28-
static base66Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
29-
static twoInt32toInt53(val: [number, number]): number;
30-
static int53toTwoInt32(val: number): [number, number];
31-
static intToBuf(int: number, len?: number, be?: boolean): Buffer;
32-
static int8ToBuf(int: number): Buffer;
33-
static int8UToBuf(int: number): Buffer;
34-
static int16ToBuf(int: number, be?: boolean): Buffer;
35-
static int16UToBuf(int: number, be?: boolean): Buffer;
36-
static int32ToBuf(int: number, be?: boolean): Buffer;
37-
static int32UToBuf(int: number, be?: boolean): Buffer;
38-
static floatToBuf(int: number, be?: boolean): Buffer;
39-
static doubleToBuf(int: number, be?: boolean): Buffer;
40-
static bufToInt8(buf: Buffer, offset?: number): number;
41-
static bufToInt8U(buf: Buffer, offset?: number): number;
42-
static bufToInt16(buf: Buffer, offset?: number, be?: boolean): number;
43-
static bufToInt16U(buf: Buffer, offset?: number, be?: boolean): number;
44-
static bufToInt32(buf: Buffer, offset?: number, be?: boolean): number;
45-
static bufToInt32U(buf: Buffer, offset?: number, be?: boolean): number;
46-
static bufToInt(buf: Buffer, len?: number, offset?: number, be?: boolean): number;
47-
static bufToFloat(buf: Buffer, offset?: number, be?: boolean): number;
48-
static bufToDouble(buf: Buffer, offset?: number, be?: boolean): number;
49-
static pad(str: string | number, z?: number): string;
50-
static bufToBinFlags(buf: Buffer | number, offset?: number): Array<boolean>;
51-
static binFlagsToBuf(arr: Array<boolean>): Buffer;
52-
static hexToBinStr(val: string): string;
53-
static crc32(data: Buffer | Uint8Array | string, previous?: number): number;
54-
}
1+
/// <reference types="node" />
2+
export declare class CoderTools {
3+
static BASE_ALPHABETS: {
4+
BASE16: string;
5+
BASE36: string;
6+
BASE58: string;
7+
BASE62: string;
8+
BASE66: string;
9+
};
10+
static isBuffer(what: any): boolean;
11+
static makeWBuffer(cb: (arg: Buffer) => void, length: number): Buffer;
12+
static toBuffer(what: string | Buffer, ascii?: boolean): Buffer;
13+
static baseXEncode(what: string | Buffer, base: string, asAscii?: boolean): string;
14+
static baseXDecode(what: string, base: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
15+
static base16Encode(what: string | Buffer, asAscii?: boolean): string;
16+
static base32Encode(what: string | Buffer, asAscii?: boolean): string;
17+
static base36Encode(what: string | Buffer, asAscii?: boolean): string;
18+
static base58Encode(what: string | Buffer, asAscii?: boolean): string;
19+
static base62Encode(what: string | Buffer, asAscii?: boolean): string;
20+
static base64Encode(what: string | Buffer, asAscii?: boolean): string;
21+
static base66Encode(what: string | Buffer, asAscii?: boolean): string;
22+
static base16Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
23+
static base32Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer | Uint8Array;
24+
static base36Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
25+
static base58Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer | Uint8Array;
26+
static base62Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
27+
static base64Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer | Uint8Array;
28+
static base66Decode(what: string, asBuffer?: boolean, asAscii?: boolean): string | Buffer;
29+
static twoInt32toInt53(val: [number, number]): number;
30+
static int53toTwoInt32(val: number): [number, number];
31+
static intToBuf(int: number, len?: number, be?: boolean): Buffer;
32+
static int8ToBuf(int: number): Buffer;
33+
static int8UToBuf(int: number): Buffer;
34+
static int16ToBuf(int: number, be?: boolean): Buffer;
35+
static int16UToBuf(int: number, be?: boolean): Buffer;
36+
static int32ToBuf(int: number, be?: boolean): Buffer;
37+
static int32UToBuf(int: number, be?: boolean): Buffer;
38+
static floatToBuf(int: number, be?: boolean): Buffer;
39+
static doubleToBuf(int: number, be?: boolean): Buffer;
40+
static bufToInt8(buf: Buffer, offset?: number): number;
41+
static bufToInt8U(buf: Buffer, offset?: number): number;
42+
static bufToInt16(buf: Buffer, offset?: number, be?: boolean): number;
43+
static bufToInt16U(buf: Buffer, offset?: number, be?: boolean): number;
44+
static bufToInt32(buf: Buffer, offset?: number, be?: boolean): number;
45+
static bufToInt32U(buf: Buffer, offset?: number, be?: boolean): number;
46+
static bufToInt(buf: Buffer, len?: number, offset?: number, be?: boolean): number;
47+
static bufToFloat(buf: Buffer, offset?: number, be?: boolean): number;
48+
static bufToDouble(buf: Buffer, offset?: number, be?: boolean): number;
49+
static pad(str: string | number, z?: number): string;
50+
static bufToBinFlags(buf: Buffer | number, offset?: number): Array<boolean>;
51+
static binFlagsToBuf(arr: Array<boolean>): Buffer;
52+
static hexToBinStr(val: string): string;
53+
static crc32(data: Buffer | Uint8Array | string, previous?: number): number;
54+
}

defs/classes/DataCoder.d.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
/// <reference types="node" />
2-
import { Packr } from 'msgpackr';
3-
import { Options } from 'msgpackr/unpack';
4-
export declare class DataCoder {
5-
private packr;
6-
constructor(options?: Options, packrInstance?: Packr | null);
7-
use(type: number, Class: Function, encode: (arg: any) => any, decode: (arg: any) => any): void;
8-
encode<T>(arg: T): Buffer;
9-
decode<T>(arg: Buffer | Uint8Array): T;
10-
}
1+
/// <reference types="node" />
2+
import { Packr } from 'msgpackr';
3+
import { Options } from 'msgpackr/unpack';
4+
export declare class DataCoder {
5+
private packr;
6+
constructor(options?: Options, packrInstance?: Packr | null);
7+
use(type: number, Class: Function, encode: (arg: any) => any, decode: (arg: any) => any): void;
8+
encode<T>(arg: T): Buffer;
9+
decode<T>(arg: Buffer | Uint8Array): T;
10+
}

defs/classes/Serializer.d.ts

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,35 @@
1-
/// <reference types="node" />
2-
import { DataCoder } from './DataCoder';
3-
interface SerializerPacketOptions {
4-
useCompress: boolean;
5-
useCRC32: boolean;
6-
useSchema?: boolean;
7-
}
8-
export type SerializerSchema = Array<string>;
9-
export interface SerializerSchemaObject {
10-
id: number;
11-
fields: SerializerSchema;
12-
}
13-
type SerializerSchemaIdOrSchemaObject = SerializerSchemaObject | number | null;
14-
export declare class Serializer {
15-
readonly version: number;
16-
private compressionLengthThreshold;
17-
coder: DataCoder;
18-
private readonly options;
19-
private schemes;
20-
constructor(coder?: DataCoder, options?: SerializerPacketOptions);
21-
private makePacket;
22-
use(id: number, detector: Function, encode: (arg: any) => any, decode: (arg: any) => any): void;
23-
registerSchema<T>(id: number, fields: T): void;
24-
unregisterSchema(id: number): void;
25-
serialize<T extends {
26-
[key: string | number | symbol]: unknown;
27-
}>(payload: T, schemaIdOrSchemaObject?: SerializerSchemaIdOrSchemaObject): Buffer;
28-
deserialize<T>(buf: Buffer | Uint8Array): T;
29-
}
30-
export {};
1+
/// <reference types="node" />
2+
import { DataCoder } from './DataCoder';
3+
interface SerializerPacketCompressor {
4+
compress(data: Buffer | Uint8Array): Buffer;
5+
decompress(data: Buffer): Buffer;
6+
}
7+
interface SerializerPacketOptions {
8+
useCompress: SerializerPacketCompressor | null;
9+
useCRC32: boolean;
10+
useSchema?: boolean;
11+
}
12+
export type SerializerSchema = Array<string>;
13+
export interface SerializerSchemaObject {
14+
id: number;
15+
fields: SerializerSchema;
16+
}
17+
type SerializerSchemaIdOrSchemaObject = SerializerSchemaObject | number | null;
18+
export declare class Serializer {
19+
readonly version: number;
20+
private compressionLengthThreshold;
21+
coder: DataCoder;
22+
private enableCompression;
23+
private readonly options;
24+
private schemes;
25+
constructor(coder?: DataCoder, options?: SerializerPacketOptions);
26+
private makePacket;
27+
use(id: number, detector: Function, encode: (arg: any) => any, decode: (arg: any) => any): void;
28+
registerSchema<T>(id: number, fields: T): void;
29+
unregisterSchema(id: number): void;
30+
serialize<T extends {
31+
[key: string | number | symbol]: unknown;
32+
}>(payload: T, schemaIdOrSchemaObject?: SerializerSchemaIdOrSchemaObject): Buffer;
33+
deserialize<T>(buf: Buffer | Uint8Array): T;
34+
}
35+
export {};

defs/index.d.ts

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
declare const _Buffer: any;
2-
import { CoderTools } from './classes/CoderTools';
3-
import { DataCoder } from './classes/DataCoder';
4-
import { Serializer } from './classes/Serializer';
5-
export { Options } from 'msgpackr/unpack';
6-
declare const dataCoder: DataCoder;
7-
declare const serializer: Serializer;
8-
export { CoderTools, dataCoder, serializer, DataCoder, Serializer, _Buffer };
9-
declare const _default: {
10-
CoderTools: typeof CoderTools;
11-
dataCoder: DataCoder;
12-
serializer: Serializer;
13-
DataCoder: typeof DataCoder;
14-
Serializer: typeof Serializer;
15-
_Buffer: any;
16-
};
17-
export default _default;
1+
declare const _Buffer: any;
2+
import { CoderTools } from './classes/CoderTools';
3+
import { DataCoder } from './classes/DataCoder';
4+
import { Serializer } from './classes/Serializer';
5+
export { Options } from 'msgpackr/unpack';
6+
declare const dataCoder: DataCoder;
7+
declare const serializer: Serializer;
8+
export { CoderTools, dataCoder, serializer, DataCoder, Serializer, _Buffer };
9+
declare const _default: {
10+
CoderTools: typeof CoderTools;
11+
dataCoder: DataCoder;
12+
serializer: Serializer;
13+
DataCoder: typeof DataCoder;
14+
Serializer: typeof Serializer;
15+
_Buffer: any;
16+
};
17+
export default _default;

defs/lib/base-x/index.d.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
/// <reference types="node" />
2-
declare function base(ALPHABET: string): base.BaseConverter;
3-
export default base;
4-
declare namespace base {
5-
interface BaseConverter {
6-
encode(buffer: Buffer | number[] | Uint8Array): string;
7-
decodeUnsafe(string: string): Buffer | undefined;
8-
decode(string: string): Buffer;
9-
}
10-
}
1+
/// <reference types="node" />
2+
declare function base(ALPHABET: string): base.BaseConverter;
3+
export default base;
4+
declare namespace base {
5+
interface BaseConverter {
6+
encode(buffer: Buffer | number[] | Uint8Array): string;
7+
decodeUnsafe(string: string): Buffer | undefined;
8+
decode(string: string): Buffer;
9+
}
10+
}

defs/lib/crc/crc32.d.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
declare function _exports(buf: any, previous: any): number;
2-
declare namespace _exports {
3-
export { calc as signed };
4-
export { fn as unsigned };
5-
export { model };
6-
}
7-
export = _exports;
8-
declare function fn(buf: any, previous: any): number;
9-
declare namespace fn { }
1+
declare function _exports(buf: any, previous: any): number;
2+
declare namespace _exports {
3+
export { calc as signed };
4+
export { fn as unsigned };
5+
export { model };
6+
}
7+
export = _exports;
8+
declare function fn(buf: any, previous: any): number;
9+
declare namespace fn { }

defs/lib/rfc4648/codec.d.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
export interface Encoding {
2-
bits: number;
3-
chars: string;
4-
codes?: {
5-
[char: string]: number;
6-
};
7-
}
8-
export interface ParseOptions {
9-
loose?: boolean;
10-
out?: new (size: number) => {
11-
[index: number]: number;
12-
};
13-
}
14-
export interface StringifyOptions {
15-
pad?: boolean;
16-
}
17-
export declare function parse(string: string, encoding: Encoding, opts?: ParseOptions): Uint8Array;
18-
export declare function stringify(data: ArrayLike<number>, encoding: Encoding, opts?: StringifyOptions): string;
1+
export interface Encoding {
2+
bits: number;
3+
chars: string;
4+
codes?: {
5+
[char: string]: number;
6+
};
7+
}
8+
export interface ParseOptions {
9+
loose?: boolean;
10+
out?: new (size: number) => {
11+
[index: number]: number;
12+
};
13+
}
14+
export interface StringifyOptions {
15+
pad?: boolean;
16+
}
17+
export declare function parse(string: string, encoding: Encoding, opts?: ParseOptions): Uint8Array;
18+
export declare function stringify(data: ArrayLike<number>, encoding: Encoding, opts?: StringifyOptions): string;

defs/lib/rfc4648/index.d.ts

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
import { parse, ParseOptions, stringify, StringifyOptions } from './codec';
2-
export declare const base16: {
3-
parse(string: string, opts?: ParseOptions): Uint8Array;
4-
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
5-
};
6-
export declare const base32: {
7-
parse(string: string, opts?: ParseOptions): Uint8Array;
8-
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
9-
};
10-
export declare const base32hex: {
11-
parse(string: string, opts?: ParseOptions): Uint8Array;
12-
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
13-
};
14-
export declare const base64: {
15-
parse(string: string, opts?: ParseOptions): Uint8Array;
16-
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
17-
};
18-
export declare const base64url: {
19-
parse(string: string, opts?: ParseOptions): Uint8Array;
20-
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
21-
};
22-
export declare const codec: {
23-
parse: typeof parse;
24-
stringify: typeof stringify;
25-
};
1+
import { parse, ParseOptions, stringify, StringifyOptions } from './codec';
2+
export declare const base16: {
3+
parse(string: string, opts?: ParseOptions): Uint8Array;
4+
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
5+
};
6+
export declare const base32: {
7+
parse(string: string, opts?: ParseOptions): Uint8Array;
8+
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
9+
};
10+
export declare const base32hex: {
11+
parse(string: string, opts?: ParseOptions): Uint8Array;
12+
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
13+
};
14+
export declare const base64: {
15+
parse(string: string, opts?: ParseOptions): Uint8Array;
16+
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
17+
};
18+
export declare const base64url: {
19+
parse(string: string, opts?: ParseOptions): Uint8Array;
20+
stringify(data: ArrayLike<number>, opts?: StringifyOptions): string;
21+
};
22+
export declare const codec: {
23+
parse: typeof parse;
24+
stringify: typeof stringify;
25+
};

0 commit comments

Comments
 (0)