Class EncodingService

Hierarchy

EncodingService

Index

Constructors

constructor

Methods

Constructors

constructor

new EncodingService(): EncodingService

Returns EncodingService

Methods

decode

decode(value: BinaryBuffer, encoding?: string): string

- Defined in packages/core/src/common/encoding-service.ts:78
Parameters
- value: BinaryBuffer
- Optional encoding: string
Returns string

decodeStream

decodeStream(source: BinaryBufferReadableStream, options: DecodeStreamOptions): Promise<DecodeStreamResult>

- Defined in packages/core/src/common/encoding-service.ts:239
Parameters
- source: BinaryBufferReadableStream
- options: DecodeStreamOptions
Returns Promise<DecodeStreamResult>

detectEncoding

detectEncoding(data: BinaryBuffer, autoGuessEncoding?: boolean): Promise<DetectedEncoding>

- Defined in packages/core/src/common/encoding-service.ts:123
Parameters
- data: BinaryBuffer
- Optional autoGuessEncoding: boolean
Returns Promise<DetectedEncoding>

Protected detectEncodingByBOMFromBuffer

detectEncodingByBOMFromBuffer(buffer: Buffer, bytesRead: number): undefined | "utf8bom" | "utf16le" | "utf16be"

- Defined in packages/core/src/common/encoding-service.ts:191
Parameters
- buffer: Buffer
- bytesRead: number
Returns undefined | "utf8bom" | "utf16le" | "utf16be"

encode

encode(value: string, options?: ResourceEncoding): BinaryBuffer

- Defined in packages/core/src/common/encoding-service.ts:67
Parameters
- value: string
- Optional options: ResourceEncoding
Returns BinaryBuffer

encodeStream

encodeStream(value: string | Readable<string>, options?: ResourceEncoding): Promise<BinaryBuffer | BinaryBufferReadable>
encodeStream(value?: string | Readable<string>, options?: ResourceEncoding): Promise<undefined | BinaryBuffer | BinaryBufferReadable>

- Defined in packages/core/src/common/encoding-service.ts:321
Parameters
- value: string | Readable<string>
- Optional options: ResourceEncoding
Returns Promise<BinaryBuffer | BinaryBufferReadable>
- Defined in packages/core/src/common/encoding-service.ts:322
Parameters
- Optional value: string | Readable<string>
- Optional options: ResourceEncoding
Returns Promise<undefined | BinaryBuffer | BinaryBufferReadable>

exists

exists(encoding: string): boolean

- Defined in packages/core/src/common/encoding-service.ts:84
Parameters
- encoding: string
Returns boolean

Protected guessEncodingByBuffer

guessEncodingByBuffer(buffer: Buffer): Promise<undefined | string>

- Defined in packages/core/src/common/encoding-service.ts:223
Parameters
- buffer: Buffer
Returns Promise<undefined | string>

toIconvEncoding

toIconvEncoding(encoding?: string): string

- Defined in packages/core/src/common/encoding-service.ts:89
Parameters
- Optional encoding: string
Returns string

toResourceEncoding

toResourceEncoding(encoding: string, options: { overwriteEncoding?: boolean; read: any }): Promise<ResourceEncoding>

- Defined in packages/core/src/common/encoding-service.ts:96
Parameters
- encoding: string
- options: { overwriteEncoding?: boolean; read: any }
  - Optional overwriteEncoding?: boolean
  - read:function
    - read(length: number): Promise<Uint8Array>
    - Defined in packages/core/src/common/encoding-service.ts:98
      Parameters
      - length: number
      Returns Promise<Uint8Array>
Returns Promise<ResourceEncoding>