mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
ff77e86e11
Global var definitions for TextDecoder and TextEncoder collide with the globals defined by "lib.dom.d.ts". Ideally we would be able to conditionally define TextDecoder and TextEncoder if they are not already defined in the current context. Since we cannot do conditional definitions in an ambient context, we export these types so the user can do this themselves (see tests). - Move global type definitions to namespace to prevent collisions with "lib.dom.d.ts" TextDecoder and TextEncoder. - Update name of namespace from "fastTextEncoder" to "fastTextEncoding" to match package name. - Update tests to manually define global vars TextDecoder and TextEncoder.
67 lines
1.8 KiB
TypeScript
67 lines
1.8 KiB
TypeScript
// Type definitions for fast-text-encoding 1.0
|
|
// Project: https://github.com/samthor/fast-text-encoding#readme
|
|
// Definitions by: Ciarán Ingle <https://github.com/inglec-arista>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.2
|
|
|
|
/**
|
|
* fast-text-encoding does not export any members, but defines the global classes
|
|
* 1) TextDecoder (https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder)
|
|
* 2) TextEncoder (https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder)
|
|
* if they are not already defined.
|
|
*
|
|
* We do not declare these globals here since they are already declared in "lib.dom.d.ts" and would
|
|
* result in name collisions. Instead, we export the types so that `TextDecoder` and `TextEncoder`
|
|
* can be manually declared in a non-DOM environment (see tests).
|
|
*/
|
|
|
|
declare namespace fastTextEncoding {
|
|
/**
|
|
* Options for `TextDecoder.decode` and `TextEncoder.encode`.
|
|
*/
|
|
interface TextEncodingOptions {
|
|
stream: boolean;
|
|
}
|
|
|
|
/**
|
|
* Options for TextDecoder constructor.
|
|
*/
|
|
interface TextDecoderOptions {
|
|
fatal: boolean;
|
|
}
|
|
|
|
/**
|
|
* TextDecoder instance.
|
|
*/
|
|
class TextDecoderClass {
|
|
encoding: string;
|
|
fatal: boolean;
|
|
ignoreBOM: boolean;
|
|
|
|
constructor(utfLabel?: string, options?: TextDecoderOptions);
|
|
|
|
decode(buffer: Uint8Array, options?: TextEncodingOptions): string;
|
|
}
|
|
|
|
/**
|
|
* TextEncoder instance.
|
|
*/
|
|
class TextEncoderClass {
|
|
encoding: string;
|
|
|
|
constructor(label?: string);
|
|
|
|
encode(string: string, options?: TextEncodingOptions): Uint8Array;
|
|
}
|
|
|
|
/**
|
|
* TextDecoder class.
|
|
*/
|
|
type TextDecoder = typeof TextDecoderClass;
|
|
|
|
/**
|
|
* TextEncoder class.
|
|
*/
|
|
type TextEncoder = typeof TextEncoderClass;
|
|
}
|