IEncodeTools | @znetstar/encode-tools

Hierarchy

IEncodeTools

Implemented by

EncodeTools

Properties

convertableFormatMimeTypes

convertableFormatMimeTypes: Map<ConvertableFormat, string>

Combined map of all SerializationFormat and ImageFormat entries to their respective MIME Types

mimeTypesConvertableFormat

mimeTypesConvertableFormat: Map<string, ConvertableFormat>

Map of MIME Type to each ImageFormat or SerializationFormat.

options

options: ConfiguredEncodingOptions

toPojoInstance

toPojoInstance: ToPojo<unknown, unknown>

Instance of toPojo to use when serializing objects

Methods

adjustImageBrightness

adjustImageBrightness(data: BinaryInputOutput, factor: number, format: ImageFormat): Promise<Buffer>

- Defined in src/IEncodeTools.ts:222
Adjust brightness of image

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

compress

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

- Defined in src/IEncodeTools.ts:192
Compresses arbitrary data using the provided format and any options

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

convertImage

convertImage(data: BinaryInputOutput, format: ImageFormat): Promise<Buffer>

- Defined in src/IEncodeTools.ts:228
Saves an image in the provided format, performing no operations on the image

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

cropImage

cropImage(data: BinaryInputOutput, dims: CropDims, format: ImageFormat): Promise<Buffer>

- Defined in src/IEncodeTools.ts:207
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
- format: ImageFormat
  
  Format to save result as
Returns Promise<Buffer>

decodeBuffer

decodeBuffer(buffer: BinaryInputOutput, format: BinaryEncoding, ...args: any[]): Buffer

- Defined in src/IEncodeTools.ts:119
Decodes binary data from the provided format returning either a node.js buffer.

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

decodeObject

decodeObject<T>(inputBuffer: BinaryInputOutput, format: BinaryEncoding, ...args: any[]): T

- Defined in src/IEncodeTools.ts:184
Decodes binary data from the provided format returning either a node.js buffer.

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

decompress

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

- Defined in src/IEncodeTools.ts:199
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: SerializationFormat): T

- Defined in src/IEncodeTools.ts:170
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
- serializationFormat: SerializationFormat
  
  Algorithm to deserialize with
Returns T

encodeBuffer

encodeBuffer(inputBuffer: BinaryInputOutput, format: BinaryEncoding, ...args: any[]): BinaryInputOutput

- Defined in src/IEncodeTools.ts:113
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

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

encodeObject

encodeObject<T>(inputObject: T, format: BinaryEncoding, ...args: any[]): BinaryInputOutput

- Defined in src/IEncodeTools.ts:177
Encodes binary data using the provided format returning either a node.js buffer, array buffer, or string

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

hash

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

- Defined in src/IEncodeTools.ts:127
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>

- Defined in src/IEncodeTools.ts:143
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>

- Defined in src/IEncodeTools.ts:135
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>

- Defined in src/IEncodeTools.ts:90
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
  
  HTTP Request
- key: string
  
  Name of the header to extract from
- Optional defaultValue: ConvertableFormat
Returns ExtractedContentType<ConvertableFormat>

headerToImageFormat

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

- Defined in src/IEncodeTools.ts:97
Extracts a ImageFormat from the specified HTTP header, or defaults to the Image Format in the options of the encoder.

Parameters
- req: HTTPRequestWithHeader
  
  HTTP Request
- key: string
  
  Name of the header to extract from
Returns ExtractedImageFormatContentType

headerToSerializationFormat

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

- Defined in src/IEncodeTools.ts:105
Extracts a SerializationFormat from the specified HTTP header, or defaults to the SerializationFormat in the options of the encoder.

Parameters
- req: HTTPRequestWithHeader
  
  HTTP Request
- key: string
  
  Name of the header to extract from
Returns ExtractedSerializationFormatContentType

resizeImage

resizeImage(data: BinaryInputOutput, dims: ImageDims, format: ImageFormat): Promise<Buffer>

- Defined in src/IEncodeTools.ts:215
Resizes an image and returns a Buffer containing the result in the provided format

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

serializeObject

serializeObject<T>(obj: T, serializationFormat: SerializationFormat, useToPojoBeforeSerializing?: boolean, encodeBuffersWhenUsingToPojo?: boolean): string | Buffer

- Defined in src/IEncodeTools.ts:162
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
- serializationFormat: SerializationFormat
  
  Algorithm to serialize with
- Optional useToPojoBeforeSerializing: boolean
  
  Use toPojo on the object before serializing
- Optional encodeBuffersWhenUsingToPojo: boolean
  
  If true, Buffers will be encoded with this.encodeBuffer when encountered.
Returns string | Buffer

uniqueId

uniqueId(idFormat: IDFormat, ...args: any[]): string | number | Buffer

- Defined in src/IEncodeTools.ts:151
Generates a unique ID using one of the available algorithms, returning the result as a Buffer, string or number.

Parameters
- 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

Hierarchy

Implemented by

Index

Properties

Methods

Properties

convertableFormatMimeTypes

mimeTypesConvertableFormat

options

toPojoInstance

Methods

adjustImageBrightness

Parameters

data: BinaryInputOutput

factor: number

format: ImageFormat

Returns Promise<Buffer>

compress

Parameters

data: BinaryInputOutput

format: CompressionFormat

Optional level: number

Rest ...args: any[]

Returns Promise<Buffer>

convertImage

Parameters

data: BinaryInputOutput

format: ImageFormat

Returns Promise<Buffer>

cropImage

Parameters

data: BinaryInputOutput

dims: CropDims

format: ImageFormat

Returns Promise<Buffer>

decodeBuffer

Parameters

buffer: BinaryInputOutput

format: BinaryEncoding

Rest ...args: any[]

Returns Buffer

decodeObject

Type parameters

T

Parameters

inputBuffer: BinaryInputOutput

format: BinaryEncoding

Rest ...args: any[]

Returns T

decompress

Parameters

data: BinaryInputOutput

format: CompressionFormat

Rest ...args: any[]

Returns Promise<Buffer>

deserializeObject

Type parameters

T

Parameters

data: string | Buffer | ArrayBuffer

serializationFormat: SerializationFormat

Returns T

encodeBuffer

Parameters

inputBuffer: BinaryInputOutput

format: BinaryEncoding

Rest ...args: any[]

Returns BinaryInputOutput

encodeObject

Type parameters

T

Parameters

inputObject: T

format: BinaryEncoding

Rest ...args: any[]

Returns BinaryInputOutput

hash

Parameters

buffer: BinaryInputOutput

algorithm: HashAlgorithm