// These types are not exported, and are only used internally
|
import * as undici from './index'
|
|
/**
|
* Take in an unknown value and return one that is of type T
|
*/
|
type Converter<T> = (object: unknown) => T
|
|
type SequenceConverter<T> = (object: unknown, iterable?: IterableIterator<T>) => T[]
|
|
type RecordConverter<K extends string, V> = (object: unknown) => Record<K, V>
|
|
interface WebidlErrors {
|
/**
|
* @description Instantiate an error
|
*/
|
exception (opts: { header: string, message: string }): TypeError
|
/**
|
* @description Instantiate an error when conversion from one type to another has failed
|
*/
|
conversionFailed (opts: {
|
prefix: string
|
argument: string
|
types: string[]
|
}): TypeError
|
/**
|
* @description Throw an error when an invalid argument is provided
|
*/
|
invalidArgument (opts: {
|
prefix: string
|
value: string
|
type: string
|
}): TypeError
|
}
|
|
interface WebIDLTypes {
|
UNDEFINED: 1,
|
BOOLEAN: 2,
|
STRING: 3,
|
SYMBOL: 4,
|
NUMBER: 5,
|
BIGINT: 6,
|
NULL: 7
|
OBJECT: 8
|
}
|
|
interface WebidlUtil {
|
/**
|
* @see https://tc39.es/ecma262/#sec-ecmascript-data-types-and-values
|
*/
|
Type (object: unknown): WebIDLTypes[keyof WebIDLTypes]
|
|
TypeValueToString (o: unknown):
|
| 'Undefined'
|
| 'Boolean'
|
| 'String'
|
| 'Symbol'
|
| 'Number'
|
| 'BigInt'
|
| 'Null'
|
| 'Object'
|
|
Types: WebIDLTypes
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#abstract-opdef-converttoint
|
*/
|
ConvertToInt (
|
V: unknown,
|
bitLength: number,
|
signedness: 'signed' | 'unsigned',
|
flags?: number
|
): number
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#abstract-opdef-integerpart
|
*/
|
IntegerPart (N: number): number
|
|
/**
|
* Stringifies {@param V}
|
*/
|
Stringify (V: any): string
|
|
MakeTypeAssertion <I>(I: I): (arg: any) => arg is I
|
|
/**
|
* Mark a value as uncloneable for Node.js.
|
* This is only effective in some newer Node.js versions.
|
*/
|
markAsUncloneable (V: any): void
|
|
IsResizableArrayBuffer (V: ArrayBufferLike): boolean
|
|
HasFlag (flag: number, attributes: number): boolean
|
}
|
|
interface WebidlConverters {
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-DOMString
|
*/
|
DOMString (V: unknown, prefix: string, argument: string, flags?: number): string
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-ByteString
|
*/
|
ByteString (V: unknown, prefix: string, argument: string): string
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-USVString
|
*/
|
USVString (V: unknown): string
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-boolean
|
*/
|
boolean (V: unknown): boolean
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-any
|
*/
|
any <Value>(V: Value): Value
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-long-long
|
*/
|
['long long'] (V: unknown): number
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-unsigned-long-long
|
*/
|
['unsigned long long'] (V: unknown): number
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-unsigned-long
|
*/
|
['unsigned long'] (V: unknown): number
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-unsigned-short
|
*/
|
['unsigned short'] (V: unknown, flags?: number): number
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#idl-ArrayBuffer
|
*/
|
ArrayBuffer (
|
V: unknown,
|
prefix: string,
|
argument: string,
|
options?: { allowResizable: boolean }
|
): ArrayBuffer
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#idl-SharedArrayBuffer
|
*/
|
SharedArrayBuffer (
|
V: unknown,
|
prefix: string,
|
argument: string,
|
options?: { allowResizable: boolean }
|
): SharedArrayBuffer
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-buffer-source-types
|
*/
|
TypedArray (
|
V: unknown,
|
T: new () => NodeJS.TypedArray,
|
prefix: string,
|
argument: string,
|
flags?: number
|
): NodeJS.TypedArray
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-buffer-source-types
|
*/
|
DataView (
|
V: unknown,
|
prefix: string,
|
argument: string,
|
flags?: number
|
): DataView
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-buffer-source-types
|
*/
|
ArrayBufferView (
|
V: unknown,
|
prefix: string,
|
argument: string,
|
flags?: number
|
): NodeJS.ArrayBufferView
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#BufferSource
|
*/
|
BufferSource (
|
V: unknown,
|
prefix: string,
|
argument: string,
|
flags?: number
|
): ArrayBuffer | NodeJS.ArrayBufferView
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#AllowSharedBufferSource
|
*/
|
AllowSharedBufferSource (
|
V: unknown,
|
prefix: string,
|
argument: string,
|
flags?: number
|
): ArrayBuffer | SharedArrayBuffer | NodeJS.ArrayBufferView
|
|
['sequence<ByteString>']: SequenceConverter<string>
|
|
['sequence<sequence<ByteString>>']: SequenceConverter<string[]>
|
|
['record<ByteString, ByteString>']: RecordConverter<string, string>
|
|
/**
|
* @see https://fetch.spec.whatwg.org/#requestinfo
|
*/
|
RequestInfo (V: unknown): undici.Request | string
|
|
/**
|
* @see https://fetch.spec.whatwg.org/#requestinit
|
*/
|
RequestInit (V: unknown): undici.RequestInit
|
|
/**
|
* @see https://html.spec.whatwg.org/multipage/webappapis.html#eventhandlernonnull
|
*/
|
EventHandlerNonNull (V: unknown): Function | null
|
|
WebSocketStreamWrite (V: unknown): ArrayBuffer | NodeJS.TypedArray | string
|
|
[Key: string]: (...args: any[]) => unknown
|
}
|
|
type WebidlIsFunction<T> = (arg: any) => arg is T
|
|
interface WebidlIs {
|
Request: WebidlIsFunction<undici.Request>
|
Response: WebidlIsFunction<undici.Response>
|
ReadableStream: WebidlIsFunction<ReadableStream>
|
Blob: WebidlIsFunction<Blob>
|
URLSearchParams: WebidlIsFunction<URLSearchParams>
|
File: WebidlIsFunction<File>
|
FormData: WebidlIsFunction<undici.FormData>
|
URL: WebidlIsFunction<URL>
|
WebSocketError: WebidlIsFunction<undici.WebSocketError>
|
AbortSignal: WebidlIsFunction<AbortSignal>
|
MessagePort: WebidlIsFunction<MessagePort>
|
USVString: WebidlIsFunction<string>
|
/**
|
* @see https://webidl.spec.whatwg.org/#BufferSource
|
*/
|
BufferSource: WebidlIsFunction<ArrayBuffer | NodeJS.TypedArray>
|
}
|
|
export interface Webidl {
|
errors: WebidlErrors
|
util: WebidlUtil
|
converters: WebidlConverters
|
is: WebidlIs
|
attributes: WebIDLExtendedAttributes
|
|
/**
|
* @description Performs a brand-check on {@param V} to ensure it is a
|
* {@param cls} object.
|
*/
|
brandCheck <Interface extends new () => unknown>(V: unknown, cls: Interface): asserts V is Interface
|
|
brandCheckMultiple <Interfaces extends (new () => unknown)[]> (list: Interfaces): (V: any) => asserts V is Interfaces[number]
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-sequence
|
* @description Convert a value, V, to a WebIDL sequence type.
|
*/
|
sequenceConverter <Type>(C: Converter<Type>): SequenceConverter<Type>
|
|
illegalConstructor (): never
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#es-to-record
|
* @description Convert a value, V, to a WebIDL record type.
|
*/
|
recordConverter <K extends string, V>(
|
keyConverter: Converter<K>,
|
valueConverter: Converter<V>
|
): RecordConverter<K, V>
|
|
/**
|
* Similar to {@link Webidl.brandCheck} but allows skipping the check if third party
|
* interfaces are allowed.
|
*/
|
interfaceConverter <Interface>(typeCheck: WebidlIsFunction<Interface>, name: string): (
|
V: unknown,
|
prefix: string,
|
argument: string
|
) => asserts V is Interface
|
|
// TODO(@KhafraDev): a type could likely be implemented that can infer the return type
|
// from the converters given?
|
/**
|
* Converts a value, V, to a WebIDL dictionary types. Allows limiting which keys are
|
* allowed, values allowed, optional and required keys. Auto converts the value to
|
* a type given a converter.
|
*/
|
dictionaryConverter (converters: {
|
key: string,
|
defaultValue?: () => unknown,
|
required?: boolean,
|
converter: (...args: unknown[]) => unknown,
|
allowedValues?: unknown[]
|
}[]): (V: unknown) => Record<string, unknown>
|
|
/**
|
* @see https://webidl.spec.whatwg.org/#idl-nullable-type
|
* @description allows a type, V, to be null
|
*/
|
nullableConverter <T>(
|
converter: Converter<T>
|
): (V: unknown) => ReturnType<typeof converter> | null
|
|
argumentLengthCheck (args: { length: number }, min: number, context: string): void
|
}
|
|
interface WebIDLExtendedAttributes {
|
/** https://webidl.spec.whatwg.org/#Clamp */
|
Clamp: number
|
/** https://webidl.spec.whatwg.org/#EnforceRange */
|
EnforceRange: number
|
/** https://webidl.spec.whatwg.org/#AllowShared */
|
AllowShared: number
|
/** https://webidl.spec.whatwg.org/#AllowResizable */
|
AllowResizable: number
|
/** https://webidl.spec.whatwg.org/#LegacyNullToEmptyString */
|
LegacyNullToEmptyString: number
|
}
|
