@yume-chan/stream-extra 2.5.3 → 3.0.0-beta.0

package/src/global/abort-signal.ts

@@ -0,0 +1,129 @@
+import type {
+    AddEventListenerOptions,
+    Event,
+    EventListenerOptions,
+    EventListenerOrEventListenerObject,
+} from "./event.js";
+import type { GlobalPrototypeOr, GlobalValueOr } from "./utils.js";
+import { getGlobalValue } from "./utils.js";
+
+interface AbortSignalEventMap {
+    abort: Event;
+}
+
+/**
+ * The **`AbortSignal`** interface represents a signal object that allows you to communicate with an asynchronous operation (such as a fetch request) and abort it if required via an AbortController object.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal)
+ */
+interface _AbortSignal {
+    /**
+     * The **`aborted`** read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (true) or not (false).
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/aborted)
+     */
+    readonly aborted: boolean;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_event) */
+    onabort: ((this: AbortSignal, ev: Event) => void) | null;
+    /**
+     * The **`reason`** read-only property returns a JavaScript value that indicates the abort reason.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/reason)
+     */
+    readonly reason: unknown;
+    /**
+     * The **`throwIfAborted()`** method throws the signal's abort reason if the signal has been aborted; otherwise it does nothing.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/throwIfAborted)
+     */
+    throwIfAborted(): void;
+    addEventListener<K extends keyof AbortSignalEventMap>(
+        type: K,
+        listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => void,
+        options?: boolean | AddEventListenerOptions,
+    ): void;
+    addEventListener(
+        type: string,
+        listener: EventListenerOrEventListenerObject,
+        options?: boolean | AddEventListenerOptions,
+    ): void;
+    removeEventListener<K extends keyof AbortSignalEventMap>(
+        type: K,
+        listener: (this: AbortSignal, ev: AbortSignalEventMap[K]) => void,
+        options?: boolean | EventListenerOptions,
+    ): void;
+    removeEventListener(
+        type: string,
+        listener: EventListenerOrEventListenerObject,
+        options?: boolean | EventListenerOptions,
+    ): void;
+}
+
+export type AbortSignal = GlobalPrototypeOr<"AbortSignal", _AbortSignal>;
+
+interface _AbortSignalConstructor {
+    /**
+     * The **`AbortSignal.abort()`** static method returns an AbortSignal that is already set as aborted (and which does not trigger an abort event).
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/abort_static)
+     */
+    abort(reason?: unknown): AbortSignal;
+    /**
+     * The **`AbortSignal.any()`** static method takes an iterable of abort signals and returns an AbortSignal. The returned abort signal is aborted when any of the input iterable abort signals are aborted. The abort reason will be set to the reason of the first signal that is aborted. If any of the given abort signals are already aborted then so will be the returned AbortSignal.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/any_static)
+     */
+    any(signals: Iterable<AbortSignal>): AbortSignal;
+    /**
+     * The **`AbortSignal.timeout()`** static method returns an AbortSignal that will automatically abort after a specified time.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal/timeout_static)
+     */
+    timeout(milliseconds: number): AbortSignal;
+}
+
+type AbortSignalConstructor = GlobalValueOr<
+    "AbortSignal",
+    _AbortSignalConstructor
+>;
+
+export const AbortSignal =
+    getGlobalValue<AbortSignalConstructor>("AbortSignal");
+
+/**
+ * The **`AbortController`** interface represents a controller object that allows you to abort one or more Web requests as and when desired.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController)
+ */
+interface _AbortController {
+    /**
+     * The **`signal`** read-only property of the AbortController interface returns an AbortSignal object instance, which can be used to communicate with/abort an asynchronous operation as desired.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/signal)
+     */
+    readonly signal: AbortSignal;
+    /**
+     * The **`abort()`** method of the AbortController interface aborts an asynchronous operation before it has completed. This is able to abort fetch requests, the consumption of any response bodies, or streams.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/abort)
+     */
+    abort(reason?: unknown): void;
+}
+
+export type AbortController = GlobalPrototypeOr<
+    "AbortController",
+    _AbortController
+>;
+
+interface _AbortControllerConstructor {
+    prototype: AbortController;
+    new (): AbortController;
+}
+
+type AbortControllerConstructor = GlobalValueOr<
+    "AbortController",
+    _AbortControllerConstructor
+>;
+
+export const AbortController =
+    getGlobalValue<AbortControllerConstructor>("AbortController");

package/src/global/compression.ts

@@ -0,0 +1,28 @@
+import type { TransformStream } from "./streams.js";
+import { getGlobalValue } from "./utils.js";
+
+export type CompressionStream = TransformStream<
+    ArrayBufferView | ArrayBufferLike,
+    Uint8Array<ArrayBuffer>
+>;
+
+interface CompressionStreamConstructor {
+    prototype: CompressionStream;
+    new (format: string): CompressionStream;
+}
+
+export const CompressionStream =
+    getGlobalValue<CompressionStreamConstructor>("CompressionStream");
+
+export type DecompressionStream = TransformStream<
+    ArrayBufferView | ArrayBufferLike,
+    Uint8Array<ArrayBuffer>
+>;
+
+interface DecompressionStreamConstructor {
+    prototype: DecompressionStream;
+    new (): DecompressionStream;
+}
+
+export const DecompressionStream =
+    getGlobalValue<DecompressionStreamConstructor>("DecompressionStream");

package/src/global/encoding.ts

@@ -0,0 +1,36 @@
+import type { TransformStream } from "./streams.js";
+import { getGlobalValue } from "./utils.js";
+
+export interface TextDecoderOptions {
+    fatal?: boolean;
+    ignoreBOM?: boolean;
+}
+
+export interface TextDecoderStream extends TransformStream<
+    ArrayBufferView | ArrayBufferLike,
+    string
+> {
+    readonly encoding: string;
+    readonly fatal: boolean;
+    readonly ignoreBOM: boolean;
+}
+
+interface TextDecoderStreamConstructor {
+    prototype: TextDecoderStream;
+    new (label?: string, options?: TextDecoderOptions): TextDecoderStream;
+}
+
+export const TextDecoderStream =
+    getGlobalValue<TextDecoderStreamConstructor>("TextDecoderStream");
+
+export interface TextEncoderStream extends TransformStream<string, Uint8Array> {
+    readonly encoding: string;
+}
+
+interface TextEncoderStreamConstructor {
+    prototype: TextEncoderStream;
+    new (): TextEncoderStream;
+}
+
+export const TextEncoderStream =
+    getGlobalValue<TextEncoderStreamConstructor>("TextEncoderStream");

package/src/global/event.ts

@@ -0,0 +1,221 @@
+import type { AbortSignal } from "./abort-signal.js";
+import type { GlobalPrototypeOr, GlobalValueOr } from "./utils.js";
+import { getGlobalValue } from "./utils.js";
+
+type DOMHighResTimeStamp = number;
+
+/**
+ * The **`Event`** interface represents an event which takes place on an EventTarget.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event)
+ */
+interface _Event {
+    /**
+     * The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)
+     */
+    readonly bubbles: boolean;
+    /**
+     * The **`cancelBubble`** property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.
+     * @deprecated
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)
+     */
+    cancelBubble: boolean;
+    /**
+     * The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)
+     */
+    readonly cancelable: boolean;
+    /**
+     * The read-only **`composed`** property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)
+     */
+    readonly composed: boolean;
+    /**
+     * The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)
+     */
+    readonly currentTarget: EventTarget | null;
+    /**
+     * The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)
+     */
+    readonly defaultPrevented: boolean;
+    /**
+     * The **`eventPhase`** read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)
+     */
+    readonly eventPhase: number;
+    /**
+     * The **`isTrusted`** read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)
+     */
+    readonly isTrusted: boolean;
+    /**
+     * The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.
+     * @deprecated
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)
+     */
+    returnValue: boolean;
+    /**
+     * The deprecated **`Event.srcElement`** is an alias for the Event.target property. Use Event.target instead.
+     * @deprecated
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)
+     */
+    readonly srcElement: EventTarget | null;
+    /**
+     * The read-only **`target`** property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)
+     */
+    readonly target: EventTarget | null;
+    /**
+     * The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)
+     */
+    readonly timeStamp: DOMHighResTimeStamp;
+    /**
+     * The **`type`** read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)
+     */
+    readonly type: string;
+    /**
+     * The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)
+     */
+    composedPath(): EventTarget[];
+    /**
+     * The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().
+     * @deprecated
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)
+     */
+    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
+    /**
+     * The **`preventDefault()`** method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)
+     */
+    preventDefault(): void;
+    /**
+     * The **`stopImmediatePropagation()`** method of the Event interface prevents other listeners of the same event from being called.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)
+     */
+    stopImmediatePropagation(): void;
+    /**
+     * The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)
+     */
+    stopPropagation(): void;
+    readonly NONE: 0;
+    readonly CAPTURING_PHASE: 1;
+    readonly AT_TARGET: 2;
+    readonly BUBBLING_PHASE: 3;
+}
+
+export type Event = GlobalPrototypeOr<"Event", _Event>;
+
+export interface EventInit {
+    bubbles?: boolean;
+    cancelable?: boolean;
+    composed?: boolean;
+}
+
+interface _EventConstructor {
+    prototype: Event;
+    new (type: string, eventInitDict?: EventInit): Event;
+    readonly NONE: 0;
+    readonly CAPTURING_PHASE: 1;
+    readonly AT_TARGET: 2;
+    readonly BUBBLING_PHASE: 3;
+}
+
+type EventConstructor = GlobalValueOr<"Event", _EventConstructor>;
+
+export const Event = getGlobalValue<EventConstructor>("Event");
+
+export interface EventListenerOptions {
+    capture?: boolean;
+}
+
+export interface AddEventListenerOptions extends EventListenerOptions {
+    once?: boolean;
+    passive?: boolean;
+    signal?: AbortSignal;
+}
+
+interface EventListener {
+    (evt: Event): void;
+}
+
+interface EventListenerObject {
+    handleEvent(object: Event): void;
+}
+
+export type EventListenerOrEventListenerObject =
+    | EventListener
+    | EventListenerObject;
+
+/**
+ * The **`EventTarget`** interface is implemented by objects that can receive events and may have listeners for them. In other words, any target of events implements the three methods associated with this interface.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget)
+ */
+interface _EventTarget {
+    /**
+     * The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
+     */
+    addEventListener(
+        type: string,
+        callback: EventListenerOrEventListenerObject | null,
+        options?: AddEventListenerOptions | boolean,
+    ): void;
+    /**
+     * The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
+     */
+    dispatchEvent(event: Event): boolean;
+    /**
+     * The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
+     */
+    removeEventListener(
+        type: string,
+        callback: EventListenerOrEventListenerObject | null,
+        options?: EventListenerOptions | boolean,
+    ): void;
+}
+
+export type EventTarget = GlobalPrototypeOr<"EventTarget", _EventTarget>;
+
+interface _EventTargetConstructor {
+    prototype: EventTarget;
+    new (): EventTarget;
+}
+
+type EventTargetConstructor = GlobalValueOr<
+    "EventTarget",
+    _EventTargetConstructor
+>;
+
+export const EventTarget =
+    getGlobalValue<EventTargetConstructor>("EventTarget");

package/src/global/index.ts

@@ -0,0 +1,6 @@
+export * from "./abort-signal.js";
+export * from "./compression.js";
+export * from "./encoding.js";
+export * from "./event.js";
+export * from "./streams.js";
+export * from "./timer.js";