EncodeToolsAuto | @znetstar/encode-tools-native

Contains tools for encoding/decoding data in different circumstances.

Will automatically use native modules (via EncodeToolsNative) if they are installed.

Hierarchy

EncodeToolsAuto

Implements

default

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new EncodeToolsAuto(nativeOptions?: Partial<ConfiguredEncodingOptions>, fallbackOptions?: Partial<ConfiguredEncodingOptions>): EncodeToolsAuto

- Defined in src/EncodeToolsAuto.ts:90
example

const enc = new EncodeToolsAuto({ hashAlgorithm: HashAlgorithm.xxhash3 }, { hashAlgorithm: HashAlgorithm.xxhash64 });

Parameters
- Optional nativeOptions: Partial<ConfiguredEncodingOptions>
  
  Options for the EncodeToolsNative constructor that will be used if the corresponding native module is available
- Optional fallbackOptions: Partial<ConfiguredEncodingOptions>
  
  A set of fallback options to be used if the native module needed for the option in the first argument is missing
Returns EncodeToolsAuto

Properties

Protected regular

regular: default

Accessors

availableNativeModules

get availableNativeModules(): AvailableNativeModules

- Defined in src/EncodeToolsAuto.ts:71
Lists all native modules that can currently be used

Returns AvailableNativeModules

convertableFormatMimeTypes

get convertableFormatMimeTypes(): Map<ConvertableFormat, string>

Implementation of default.convertableFormatMimeTypes
- Defined in src/EncodeToolsAuto.ts:133
Combined map of all SerializationFormat and ImageFormat entries to their respective MIME Types

Returns Map<ConvertableFormat, string>

mimeTypesConvertableFormat

get mimeTypesConvertableFormat(): Map<string, ConvertableFormat>

Implementation of default.mimeTypesConvertableFormat
- Defined in src/EncodeToolsAuto.ts:139
Map of MIME Type to each ImageFormat or SerializationFormat.

Returns Map<string, ConvertableFormat>

toPojoInstance

get toPojoInstance(): ToPojo<unknown, unknown>

Implementation of default.toPojoInstance
- Defined in src/EncodeToolsAuto.ts:87
Instance of toPojo to use when serializing objects

Returns ToPojo<unknown, unknown>

Static WithDefaults

get WithDefaults(): EncodeToolsAuto

- Defined in src/EncodeToolsAuto.ts:914
Returns an EncodeTools instance with the default properties

Returns EncodeToolsAuto

Methods

adjustImageBrightness

adjustImageBrightness(buffer: Buffer | ArrayBuffer, factor: number, format?: png): Promise<Buffer>
adjustImageBrightness(buffer: Buffer | ArrayBuffer, factor: number, format?: jpeg): Promise<Buffer>
adjustImageBrightness(buffer: BinaryInputOutput, factor: number, format?: ImageFormat): Promise<Buffer>

Implementation of default.adjustImageBrightness
- Defined in src/EncodeToolsAuto.ts:161
Adjust brightness of image

Parameters
- buffer: Buffer | ArrayBuffer
  
  Image
- factor: number
- Optional format: png
  
  Format to save result as
Returns Promise<Buffer>
Implementation of IEncodeTools.adjustImageBrightness
- Defined in src/EncodeToolsAuto.ts:168
Adjust brightness of image

Parameters
- buffer: Buffer | ArrayBuffer
  
  Image
- factor: number
- Optional format: jpeg
  
  Format to save result as
Returns Promise<Buffer>
Implementation of IEncodeTools.adjustImageBrightness
- Defined in src/EncodeToolsAuto.ts:175
Adjust brightness of image

Parameters
- buffer: BinaryInputOutput
  
  Image
- factor: number
- Optional format: ImageFormat
  
  Format to save result as
Returns Promise<Buffer>

compress

compress(data: Buffer | ArrayBuffer, format?: lzma, level?: number, ...args: any[]): Promise<Buffer>
compress(data: Buffer | ArrayBuffer, format?: zstd, level?: number, ...args: any[]): Promise<Buffer>
compress(data: BinaryInputOutput, format?: CompressionFormat, level?: number, ...args: any[]): Promise<Buffer>

Implementation of default.compress
- Defined in src/EncodeToolsAuto.ts:388
Compresses arbitrary data using the provided format and any options

Parameters
- data: Buffer | ArrayBuffer
  
  Data to compress
- Optional format: lzma
  
  Format to use
- Optional level: number
- Rest ...args: any[]
  
  Options
Returns Promise<Buffer>
Implementation of IEncodeTools.compress
- Defined in src/EncodeToolsAuto.ts:395
Compresses arbitrary data using the provided format and any options

Parameters
- data: Buffer | ArrayBuffer
  
  Data to compress
- Optional format: zstd
  
  Format to use
- Optional level: number
- Rest ...args: any[]
  
  Options
Returns Promise<Buffer>
Implementation of IEncodeTools.compress
- Defined in src/EncodeToolsAuto.ts:402
Compresses arbitrary data using the provided format and any options

Parameters
- data: BinaryInputOutput
  
  Data to compress
- Optional format: CompressionFormat
  
  Format to use
- Optional level: number
- Rest ...args: any[]
  
  Options
Returns Promise<Buffer>

convertImage

convertImage(buffer: Buffer | ArrayBuffer, format?: png): Promise<Buffer>
convertImage(buffer: Buffer | ArrayBuffer, format?: jpeg): Promise<Buffer>
convertImage(data: BinaryInputOutput, format?: ImageFormat): Promise<Buffer>

Implementation of default.convertImage
- Defined in src/EncodeToolsAuto.ts:195
Saves an image in the provided format, performing no operations on the image

Parameters
- buffer: Buffer | ArrayBuffer
  
  Image
- Optional format: png
  
  Format to save result as
Returns Promise<Buffer>
Implementation of IEncodeTools.convertImage
- Defined in src/EncodeToolsAuto.ts:201
Saves an image in the provided format, performing no operations on the image

Parameters
- buffer: Buffer | ArrayBuffer
  
  Image
- Optional format: jpeg
  
  Format to save result as
Returns Promise<Buffer>
Implementation of IEncodeTools.convertImage
- Defined in src/EncodeToolsAuto.ts:207
Saves an image in the provided format, performing no operations on the image

Parameters
- data: BinaryInputOutput
  
  Image
- Optional format: ImageFormat
  
  Format to save result as
Returns Promise<Buffer>

cropImage

cropImage(buffer: Buffer | ArrayBuffer, dims: CropDims, format?: png): Promise<Buffer>
cropImage(buffer: Buffer | ArrayBuffer, dims: CropDims, format?: jpeg): Promise<Buffer>
cropImage(data: BinaryInputOutput, dims: CropDims, format?: ImageFormat): Promise<Buffer>

Implementation of default.cropImage
- Defined in src/EncodeToolsAuto.ts:262
Crops an image and returns a Buffer containing the result in the provided format

Parameters
- buffer: Buffer | ArrayBuffer
  
  Image
- dims: CropDims
  
  Height/Width to resize to
- Optional format: png
  
  Format to save result as
Returns Promise<Buffer>
Implementation of IEncodeTools.cropImage
- Defined in src/EncodeToolsAuto.ts:269
Crops an image and returns a Buffer containing the result in the provided format

Parameters
- buffer: Buffer | ArrayBuffer
  
  Image
- dims: CropDims
  
  Height/Width to resize to
- Optional format: jpeg
  
  Format to save result as
Returns Promise<Buffer>
Implementation of IEncodeTools.cropImage
- Defined in src/EncodeToolsAuto.ts:276
Crops an image and returns a Buffer containing the result in the provided format

Parameters
- data: BinaryInputOutput
  
  Image
- dims: CropDims
  
  Height/Width to resize to
- Optional format: ImageFormat
  
  Format to save result as
Returns Promise<Buffer>

decodeBuffer

decodeBuffer(buffer: ArrayBuffer, format?: arrayBuffer, ...args: any[]): Buffer
decodeBuffer(buffer: Buffer, format?: nodeBuffer, ...args: any[]): Buffer
decodeBuffer(input: string, format?: hex, ...args: any[]): Buffer
decodeBuffer(input: string, format?: base32, ...args: any[]): Buffer
decodeBuffer(input: string, format?: hashids, ...args: any[]): Buffer
decodeBuffer(input: string, format?: base64, ...args: any[]): Buffer
decodeBuffer(input: string, format?: base64url, ...args: any[]): Buffer
decodeBuffer(input: string, format?: ascii85, ...args: any[]): Buffer
decodeBuffer(input: string, format?: ascii85, ...args: any[]): Buffer
decodeBuffer(buffer: BinaryInputOutput, format?: BinaryEncoding, ...args: any[]): Buffer

Implementation of default.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:698
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- buffer: ArrayBuffer
- Optional format: arrayBuffer
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:704
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- buffer: Buffer
- Optional format: nodeBuffer
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:710
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- input: string
- Optional format: hex
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:716
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- input: string
- Optional format: base32
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:722
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- input: string
- Optional format: hashids
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:728
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- input: string
- Optional format: base64
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:734
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- input: string
- Optional format: base64url
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:740
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- input: string
- Optional format: ascii85
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:752
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- input: string
- Optional format: ascii85
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.decodeBuffer
- Defined in src/EncodeToolsAuto.ts:758
Decodes binary data from the provided format returning either a node.js buffer.

Parameters
- buffer: BinaryInputOutput
- Optional format: BinaryEncoding
- Rest ...args: any[]
Returns Buffer

decodeObject

decodeObject<T>(buffer: Buffer, format?: nodeBuffer, ...args: any[]): T
decodeObject<T>(buffer: string, format?: base64, ...args: any[]): T
decodeObject<T>(buffer: string, format?: base64url, ...args: any[]): T
decodeObject<T>(buffer: string, format?: hex, ...args: any[]): T
decodeObject<T>(buffer: string, format?: base32, ...args: any[]): T
decodeObject<T>(buffer: string, format?: hashids, ...args: any[]): T
decodeObject<T>(buffer: ArrayBuffer, format?: arrayBuffer, ...args: any[]): T
decodeObject<T>(buffer: string, format?: ascii85, ...args: any[]): T
decodeObject<T>(buffer: string, format?: ascii85, ...args: any[]): T
decodeObject<T>(inputBuffer: BinaryInputOutput, format?: BinaryEncoding, ...args: any[]): T

Implementation of default.decodeObject
- Defined in src/EncodeToolsAuto.ts:618
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- buffer: Buffer
- Optional format: nodeBuffer
- Rest ...args: any[]
Returns T
Implementation of IEncodeTools.decodeObject
- Defined in src/EncodeToolsAuto.ts:624
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- buffer: string
- Optional format: base64
- Rest ...args: any[]
Returns T
Implementation of IEncodeTools.decodeObject
- Defined in src/EncodeToolsAuto.ts:630
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- buffer: string
- Optional format: base64url
- Rest ...args: any[]
Returns T
Implementation of IEncodeTools.decodeObject
- Defined in src/EncodeToolsAuto.ts:636
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- buffer: string
- Optional format: hex
- Rest ...args: any[]
Returns T
Implementation of IEncodeTools.decodeObject
- Defined in src/EncodeToolsAuto.ts:642
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- buffer: string
- Optional format: base32
- Rest ...args: any[]
Returns T
Implementation of IEncodeTools.decodeObject
- Defined in src/EncodeToolsAuto.ts:648
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- buffer: string
- Optional format: hashids
- Rest ...args: any[]
Returns T
Implementation of IEncodeTools.decodeObject
- Defined in src/EncodeToolsAuto.ts:654
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- buffer: ArrayBuffer
- Optional format: arrayBuffer
- Rest ...args: any[]
Returns T
Implementation of IEncodeTools.decodeObject
- Defined in src/EncodeToolsAuto.ts:660
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- buffer: string
- Optional format: ascii85
- Rest ...args: any[]
Returns T
Implementation of IEncodeTools.decodeObject
- Defined in src/EncodeToolsAuto.ts:672
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- buffer: string
- Optional format: ascii85
- Rest ...args: any[]
Returns T
Implementation of IEncodeTools.decodeObject
- Defined in src/EncodeToolsAuto.ts:678
Decodes binary data from the provided format returning either a node.js buffer.

Type parameters
- T
Parameters
- inputBuffer: BinaryInputOutput
- Optional format: BinaryEncoding
- Rest ...args: any[]
Returns T

decompress

decompress(data: Buffer | ArrayBuffer, format: lzma, ...args: any[]): Promise<Buffer>
decompress(data: Buffer | ArrayBuffer, format: zstd, ...args: any[]): Promise<Buffer>
decompress(data: BinaryInputOutput, format: CompressionFormat, ...args: any[]): Promise<Buffer>

Implementation of default.decompress
- Defined in src/EncodeToolsAuto.ts:356
Decompresses arbitrary data using the provided format and any options

Parameters
- data: Buffer | ArrayBuffer
  
  Data to decompress
- format: lzma
  
  Format to use
- Rest ...args: any[]
Returns Promise<Buffer>
Implementation of IEncodeTools.decompress
- Defined in src/EncodeToolsAuto.ts:362
Decompresses arbitrary data using the provided format and any options

Parameters
- data: Buffer | ArrayBuffer
  
  Data to decompress
- format: zstd
  
  Format to use
- Rest ...args: any[]
Returns Promise<Buffer>
Implementation of IEncodeTools.decompress
- Defined in src/EncodeToolsAuto.ts:368
Decompresses arbitrary data using the provided format and any options

Parameters
- data: BinaryInputOutput
  
  Data to decompress
- format: CompressionFormat
  
  Format to use
- Rest ...args: any[]
Returns Promise<Buffer>

deserializeObject

deserializeObject<T>(data: string | Buffer | ArrayBuffer, serializationFormat?: json): T
deserializeObject<T>(data: string | Buffer | ArrayBuffer, serializationFormat?: json5): T
deserializeObject<T>(data: Buffer | ArrayBuffer, serializationFormat?: cbor): T
deserializeObject<T>(data: Buffer | ArrayBuffer, serializationFormat?: msgpack): T
deserializeObject<T>(data: Buffer | ArrayBuffer, serializationFormat?: bson): T
deserializeObject<T>(data: Buffer | ArrayBuffer, serializationFormat?: SerializationFormat): T

Implementation of default.deserializeObject
- Defined in src/EncodeToolsAuto.ts:479
Deserializes an object serialized using one of the available algorithms, returning the result as an object

Type parameters
- T
Parameters
- data: string | Buffer | ArrayBuffer
  
  Data to deserialize
- Optional serializationFormat: json
  
  Algorithm to deserialize with
Returns T
Implementation of IEncodeTools.deserializeObject
- Defined in src/EncodeToolsAuto.ts:486
Deserializes an object serialized using one of the available algorithms, returning the result as an object

Type parameters
- T
Parameters
- data: string | Buffer | ArrayBuffer
  
  Data to deserialize
- Optional serializationFormat: json5
  
  Algorithm to deserialize with
Returns T
Implementation of IEncodeTools.deserializeObject
- Defined in src/EncodeToolsAuto.ts:493
Deserializes an object serialized using one of the available algorithms, returning the result as an object

Type parameters
- T
Parameters
- data: Buffer | ArrayBuffer
  
  Data to deserialize
- Optional serializationFormat: cbor
  
  Algorithm to deserialize with
Returns T
Implementation of IEncodeTools.deserializeObject
- Defined in src/EncodeToolsAuto.ts:500
Deserializes an object serialized using one of the available algorithms, returning the result as an object

Type parameters
- T
Parameters
- data: Buffer | ArrayBuffer
  
  Data to deserialize
- Optional serializationFormat: msgpack
  
  Algorithm to deserialize with
Returns T
Implementation of IEncodeTools.deserializeObject
- Defined in src/EncodeToolsAuto.ts:507
Deserializes an object serialized using one of the available algorithms, returning the result as an object

Type parameters
- T
Parameters
- data: Buffer | ArrayBuffer
  
  Data to deserialize
- Optional serializationFormat: bson
  
  Algorithm to deserialize with
Returns T
Implementation of IEncodeTools.deserializeObject
- Defined in src/EncodeToolsAuto.ts:514
Deserializes an object serialized using one of the available algorithms, returning the result as an object

Type parameters
- T
Parameters
- data: Buffer | ArrayBuffer
  
  Data to deserialize
- Optional serializationFormat: SerializationFormat
  
  Algorithm to deserialize with
Returns T

encodeBuffer

encodeBuffer(inputBuffer: Buffer | ArrayBuffer, format?: nodeBuffer, ...args: any[]): Buffer
encodeBuffer(inputBuffer: Buffer | ArrayBuffer, format?: arrayBuffer, ...args: any[]): ArrayBuffer
encodeBuffer(inputBuffer: string | Buffer | ArrayBuffer, format?: hex, ...args: any[]): string
encodeBuffer(inputBuffer: string | Buffer | ArrayBuffer, format?: base64, ...args: any[]): string
encodeBuffer(inputBuffer: string | Buffer | ArrayBuffer, format?: base32, ...args: any[]): string
encodeBuffer(inputBuffer: string | Buffer | ArrayBuffer, format?: base64url, ...args: any[]): string
encodeBuffer(inputBuffer: string | Buffer | ArrayBuffer, format?: hashids, ...args: any[]): string
encodeBuffer(inputBuffer: string | Buffer | ArrayBuffer, format?: ascii85, ...args: any[]): string
encodeBuffer(inputBuffer: string | Buffer | ArrayBuffer, format?: ascii85, ...args: any[]): string
encodeBuffer(inputBuffer: BinaryInputOutput, format?: BinaryEncoding, ...args: any[]): BinaryInputOutput

Implementation of default.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:773
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: Buffer | ArrayBuffer
- Optional format: nodeBuffer
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:779
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: Buffer | ArrayBuffer
- Optional format: arrayBuffer
- Rest ...args: any[]
Returns ArrayBuffer
Implementation of IEncodeTools.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:785
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: string | Buffer | ArrayBuffer
- Optional format: hex
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:791
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: string | Buffer | ArrayBuffer
- Optional format: base64
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:797
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: string | Buffer | ArrayBuffer
- Optional format: base32
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:803
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: string | Buffer | ArrayBuffer
- Optional format: base64url
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:809
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: string | Buffer | ArrayBuffer
- Optional format: hashids
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:815
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: string | Buffer | ArrayBuffer
- Optional format: ascii85
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:827
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: string | Buffer | ArrayBuffer
- Optional format: ascii85
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeBuffer
- Defined in src/EncodeToolsAuto.ts:833
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Parameters
- inputBuffer: BinaryInputOutput
- Optional format: BinaryEncoding
- Rest ...args: any[]
Returns BinaryInputOutput

encodeObject

encodeObject<T>(inputObject: T, format?: nodeBuffer, ...args: any[]): Buffer
encodeObject<T>(inputObject: T, format?: base64, ...args: any[]): string
encodeObject<T>(inputObject: T, format?: base64url, ...args: any[]): string
encodeObject<T>(inputObject: T, format?: hex, ...args: any[]): string
encodeObject<T>(inputObject: T, format?: base32, ...args: any[]): string
encodeObject<T>(inputObject: T, format?: hashids, ...args: any[]): string
encodeObject<T>(inputObject: T, format?: arrayBuffer, ...args: any[]): ArrayBuffer
encodeObject<T>(inputObject: T, format?: ascii85, ...args: any[]): string
encodeObject<T>(inputObject: T, format?: ascii85, ...args: any[]): string
encodeObject<T>(inputObject: T, format?: BinaryEncoding, ...args: any[]): BinaryInputOutput

Implementation of default.encodeObject
- Defined in src/EncodeToolsAuto.ts:534
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: nodeBuffer
- Rest ...args: any[]
Returns Buffer
Implementation of IEncodeTools.encodeObject
- Defined in src/EncodeToolsAuto.ts:540
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: base64
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeObject
- Defined in src/EncodeToolsAuto.ts:546
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: base64url
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeObject
- Defined in src/EncodeToolsAuto.ts:552
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: hex
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeObject
- Defined in src/EncodeToolsAuto.ts:558
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: base32
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeObject
- Defined in src/EncodeToolsAuto.ts:564
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: hashids
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeObject
- Defined in src/EncodeToolsAuto.ts:570
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: arrayBuffer
- Rest ...args: any[]
Returns ArrayBuffer
Implementation of IEncodeTools.encodeObject
- Defined in src/EncodeToolsAuto.ts:581
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: ascii85
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeObject
- Defined in src/EncodeToolsAuto.ts:593
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: ascii85
- Rest ...args: any[]
Returns string
Implementation of IEncodeTools.encodeObject
- Defined in src/EncodeToolsAuto.ts:599
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

Type parameters
- T
Parameters
- inputObject: T
- Optional format: BinaryEncoding
- Rest ...args: any[]
Returns BinaryInputOutput

hash

hash(buffer: BinaryInputOutput, algorithm?: HashAlgorithm, ...args: any[]): Promise<Buffer>

Implementation of default.hash
- Defined in src/EncodeToolsAuto.ts:297
Hashes data using the provided algorithm, returning a node.js Buffer.

Parameters
- buffer: BinaryInputOutput
- algorithm: HashAlgorithm = ...
- Rest ...args: any[]
Returns Promise<Buffer>

hashObject

hashObject(obj: any, algorithm?: HashAlgorithm, ...args: any[]): Promise<Buffer>

Implementation of default.hashObject
- Defined in src/EncodeToolsAuto.ts:337
Hashes an object using the provided algorithm, returning a node.js Buffer.

Parameters
- obj: any
- algorithm: HashAlgorithm = ...
- Rest ...args: any[]
Returns Promise<Buffer>

hashString

hashString(buffer: BinaryInputOutput, algorithm?: HashAlgorithm, ...args: any[]): Promise<string>

Implementation of default.hashString
- Defined in src/EncodeToolsAuto.ts:317
Hashes data using the provided algorithm, returning a node.js Buffer.

Parameters
- buffer: BinaryInputOutput
- algorithm: HashAlgorithm = ...
- Rest ...args: any[]
Returns Promise<string>

headerToConvertableFormat

headerToConvertableFormat(req: HTTPRequestWithHeader, key: string, defaultValue?: ConvertableFormat): ExtractedContentType<ConvertableFormat>

Implementation of default.headerToConvertableFormat
- Defined in src/EncodeToolsAuto.ts:143
Extracts a SerializationFormat or ImageFormat from the specified HTTP header, or defaults to the SerializationFormat or Image Format in the options of the encoder.

Parameters
- req: HTTPRequestWithHeader
- key: string
- Optional defaultValue: ConvertableFormat
Returns ExtractedContentType<ConvertableFormat>

headerToImageFormat

headerToImageFormat(req: HTTPRequestWithHeader, key: string): ExtractedImageFormatContentType

Implementation of default.headerToImageFormat
- Defined in src/EncodeToolsAuto.ts:151
Extracts a ImageFormat from the specified HTTP header, or defaults to the Image Format in the options of the encoder.

Parameters
- req: HTTPRequestWithHeader
- key: string
Returns ExtractedImageFormatContentType

headerToSerializationFormat

headerToSerializationFormat(req: HTTPRequestWithHeader, key: string): ExtractedSerializationFormatContentType

Implementation of default.headerToSerializationFormat
- Defined in src/EncodeToolsAuto.ts:147
Extracts a SerializationFormat from the specified HTTP header, or defaults to the SerializationFormat in the options of the encoder.

Parameters
- req: HTTPRequestWithHeader
- key: string
Returns ExtractedSerializationFormatContentType

resizeImage

resizeImage(buffer: Buffer | ArrayBuffer, dims: { height: number; width?: number } | { height?: number; width: number }, format?: png): Promise<Buffer>
resizeImage(buffer: Buffer | ArrayBuffer, dims: { height: number; width?: number } | { height?: number; width: number }, format?: jpeg): Promise<Buffer>
resizeImage(data: BinaryInputOutput, dims: { height: number; width?: number } | { height?: number; width: number }, format?: ImageFormat): Promise<Buffer>

Implementation of default.resizeImage
- Defined in src/EncodeToolsAuto.ts:227
Resizes an image and returns a Buffer containing the result in the provided format

Parameters
- buffer: Buffer | ArrayBuffer
  
  Image
- dims: { height: number; width?: number } | { height?: number; width: number }
  
  Height/Width to resize to
- Optional format: png
  
  Format to save result as
Returns Promise<Buffer>
Implementation of IEncodeTools.resizeImage
- Defined in src/EncodeToolsAuto.ts:234
Resizes an image and returns a Buffer containing the result in the provided format

Parameters
- buffer: Buffer | ArrayBuffer
  
  Image
- dims: { height: number; width?: number } | { height?: number; width: number }
  
  Height/Width to resize to
- Optional format: jpeg
  
  Format to save result as
Returns Promise<Buffer>
Implementation of IEncodeTools.resizeImage
- Defined in src/EncodeToolsAuto.ts:241
Resizes an image and returns a Buffer containing the result in the provided format

Parameters
- data: BinaryInputOutput
  
  Image
- dims: { height: number; width?: number } | { height?: number; width: number }
  
  Height/Width to resize to
- Optional format: ImageFormat
  
  Format to save result as
Returns Promise<Buffer>

serializeObject

serializeObject<T>(obj: T, serializationFormat?: json, useToPojoBeforeSerializing?: boolean): string
serializeObject<T>(obj: T, serializationFormat?: json5, useToPojoBeforeSerializing?: boolean): string
serializeObject<T>(obj: T, serializationFormat?: cbor, useToPojoBeforeSerializing?: boolean): Buffer
serializeObject<T>(obj: T, serializationFormat?: msgpack, useToPojoBeforeSerializing?: boolean): Buffer
serializeObject<T>(obj: T, serializationFormat?: bson, useToPojoBeforeSerializing?: boolean): Buffer
serializeObject<T>(obj: T, serializationFormat?: SerializationFormat, useToPojoBeforeSerializing?: boolean): Buffer

Implementation of default.serializeObject
- Defined in src/EncodeToolsAuto.ts:423
Serializes an object using one of the available algorithms, returning the result as a Buffer or a string

Type parameters
- T
Parameters
- obj: T
  
  Object to serialize
- Optional serializationFormat: json
  
  Algorithm to serialize with
- Optional useToPojoBeforeSerializing: boolean
Returns string
Implementation of IEncodeTools.serializeObject
- Defined in src/EncodeToolsAuto.ts:430
Serializes an object using one of the available algorithms, returning the result as a Buffer or a string

Type parameters
- T
Parameters
- obj: T
  
  Object to serialize
- Optional serializationFormat: json5
  
  Algorithm to serialize with
- Optional useToPojoBeforeSerializing: boolean
Returns string
Implementation of IEncodeTools.serializeObject
- Defined in src/EncodeToolsAuto.ts:437
Serializes an object using one of the available algorithms, returning the result as a Buffer or a string

Type parameters
- T
Parameters
- obj: T
  
  Object to serialize
- Optional serializationFormat: cbor
  
  Algorithm to serialize with
- Optional useToPojoBeforeSerializing: boolean
Returns Buffer
Implementation of IEncodeTools.serializeObject
- Defined in src/EncodeToolsAuto.ts:444
Serializes an object using one of the available algorithms, returning the result as a Buffer or a string

Type parameters
- T
Parameters
- obj: T
  
  Object to serialize
- Optional serializationFormat: msgpack
  
  Algorithm to serialize with
- Optional useToPojoBeforeSerializing: boolean
Returns Buffer
Implementation of IEncodeTools.serializeObject
- Defined in src/EncodeToolsAuto.ts:451
Serializes an object using one of the available algorithms, returning the result as a Buffer or a string

Type parameters
- T
Parameters
- obj: T
  
  Object to serialize
- Optional serializationFormat: bson
  
  Algorithm to serialize with
- Optional useToPojoBeforeSerializing: boolean
Returns Buffer
Implementation of IEncodeTools.serializeObject
- Defined in src/EncodeToolsAuto.ts:458
Serializes an object using one of the available algorithms, returning the result as a Buffer or a string

Type parameters
- T
Parameters
- obj: T
  
  Object to serialize
- Optional serializationFormat: SerializationFormat
  
  Algorithm to serialize with
- Optional useToPojoBeforeSerializing: boolean
Returns Buffer

uniqueId

uniqueId(idFormat: uuidv4): Buffer
uniqueId(idFormat: uuidv1): Buffer
uniqueId(idFormat: uuidv4String): string
uniqueId(idFormat: uuidv1String): string
uniqueId(idFormat: objectId): Buffer
uniqueId(idFormat: nanoid, size?: number): string
uniqueId(idFormat: timestamp): number
uniqueId(idFormat?: IDFormat, ...args: any[]): string | number | Buffer

Implementation of default.uniqueId
- Defined in src/EncodeToolsAuto.ts:850
Generates a unique ID using one of the available algorithms, returning the result as a Buffer, string or number.

Parameters
- idFormat: uuidv4
  
  Algorithm to use to generate the unique id
Returns Buffer
Implementation of IEncodeTools.uniqueId
- Defined in src/EncodeToolsAuto.ts:857
Generates a unique ID using one of the available algorithms, returning the result as a Buffer, string or number.

Parameters
- idFormat: uuidv1
  
  Algorithm to use to generate the unique id
Returns Buffer
Implementation of IEncodeTools.uniqueId
- Defined in src/EncodeToolsAuto.ts:864
Generates a unique ID using one of the available algorithms, returning the result as a Buffer, string or number.

Parameters
- idFormat: uuidv4String
  
  Algorithm to use to generate the unique id
Returns string
Implementation of IEncodeTools.uniqueId
- Defined in src/EncodeToolsAuto.ts:871
Generates a unique ID using one of the available algorithms, returning the result as a Buffer, string or number.

Parameters
- idFormat: uuidv1String
  
  Algorithm to use to generate the unique id
Returns string
Implementation of IEncodeTools.uniqueId
- Defined in src/EncodeToolsAuto.ts:878
Generates a unique ID using one of the available algorithms, returning the result as a Buffer, string or number.

Parameters
- idFormat: objectId
  
  Algorithm to use to generate the unique id
Returns Buffer
Implementation of IEncodeTools.uniqueId
- Defined in src/EncodeToolsAuto.ts:885
Generates a unique ID using one of the available algorithms, returning the result as a Buffer, string or number.

Parameters
- idFormat: nanoid
  
  Algorithm to use to generate the unique id
- Optional size: number
Returns string
Implementation of IEncodeTools.uniqueId
- Defined in src/EncodeToolsAuto.ts:892
Generates a unique ID using one of the available algorithms, returning the result as a Buffer, string or number.

Parameters
- idFormat: timestamp
  
  Algorithm to use to generate the unique id
Returns number
Implementation of IEncodeTools.uniqueId
- Defined in src/EncodeToolsAuto.ts:899
Generates a unique ID using one of the available algorithms, returning the result as a Buffer, string or number.

Parameters
- Optional idFormat: IDFormat
  
  Algorithm to use to generate the unique id
- Rest ...args: any[]
  
  Extra args to pass to the ID generation function
Returns string | number | Buffer

Static create

create(nativeOptions?: Partial<ConfiguredEncodingOptions>, fallbackOptions?: Partial<ConfiguredEncodingOptions>): default

- Defined in src/EncodeToolsAuto.ts:920
Creates an an EncodeTools instance with the provided properties

Parameters
- Optional nativeOptions: Partial<ConfiguredEncodingOptions>
- Optional fallbackOptions: Partial<ConfiguredEncodingOptions>
Returns default

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional nativeOptions: Partial<ConfiguredEncodingOptions>

Optional fallbackOptions: Partial<ConfiguredEncodingOptions>

Returns EncodeToolsAuto

Properties

Protected fallbackOptions

Protected native

Protected nativeOptions

options

Protected regular

Accessors

availableNativeModules

Returns AvailableNativeModules

convertableFormatMimeTypes

Returns Map<ConvertableFormat, string>

mimeTypesConvertableFormat

Returns Map<string, ConvertableFormat>

toPojoInstance

Returns ToPojo<unknown, unknown>

Static WithDefaults

Returns EncodeToolsAuto

Methods

adjustImageBrightness

Parameters

buffer: Buffer | ArrayBuffer

factor: number

Optional format: png

Returns Promise<Buffer>

Parameters

buffer: Buffer | ArrayBuffer

factor: number

Optional format: jpeg

Returns Promise<Buffer>

Parameters

buffer: BinaryInputOutput

factor: number

Optional format: ImageFormat

Returns Promise<Buffer>

compress

Parameters

data: Buffer | ArrayBuffer

Optional format: lzma

Optional level: number

Rest ...args: any[]

Returns Promise<Buffer>

Parameters

data: Buffer | ArrayBuffer

Optional format: zstd

Optional level: number

Rest ...args: any[]

Returns Promise<Buffer>

Parameters

data: BinaryInputOutput

Optional format: CompressionFormat

Optional level: number

Rest ...args: any[]

Returns Promise<Buffer>

convertImage

Parameters

buffer: Buffer | ArrayBuffer

Optional format: png

Returns Promise<Buffer>

Parameters

buffer: Buffer | ArrayBuffer

Optional format: jpeg

Returns Promise<Buffer>

Parameters

data: BinaryInputOutput

Optional format: ImageFormat

Returns Promise<Buffer>

cropImage