mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-14 01:43:14 +08:00
76 lines
1.9 KiB
TypeScript
76 lines
1.9 KiB
TypeScript
import { Observable } from '../data/observable';
|
|
|
|
// Known Limitation
|
|
// Use `any` because the type of `AbortSignal` in `lib.dom.d.ts` is wrong and
|
|
// to make assignable our `AbortSignal` into that.
|
|
// https://github.com/Microsoft/TSJS-lib-generator/pull/623
|
|
type Events = {
|
|
abort: any; // Event & Type<"abort">
|
|
};
|
|
type EventAttributes = {
|
|
onabort: any; // Event & Type<"abort">
|
|
};
|
|
|
|
/**
|
|
* The signal class.
|
|
* @see https://dom.spec.whatwg.org/#abortsignal
|
|
*/
|
|
export default class AbortSignal extends Observable {
|
|
/**
|
|
* AbortSignal cannot be constructed directly.
|
|
*/
|
|
public constructor() {
|
|
super();
|
|
}
|
|
|
|
/**
|
|
* Returns `true` if this `AbortSignal`'s `AbortController` has signaled to abort, and `false` otherwise.
|
|
*/
|
|
public get aborted(): boolean {
|
|
const aborted = abortedFlags.get(this);
|
|
if (typeof aborted !== 'boolean') {
|
|
throw new TypeError(`Expected 'this' to be an 'AbortSignal' object, but got ${this === null ? 'null' : typeof this}`);
|
|
}
|
|
return aborted;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create an AbortSignal object.
|
|
*/
|
|
export function createAbortSignal(): AbortSignal {
|
|
const signal = new AbortSignal();
|
|
abortedFlags.set(signal, false);
|
|
return signal;
|
|
}
|
|
|
|
/**
|
|
* Abort a given signal.
|
|
*/
|
|
export function abortSignal(signal: AbortSignal): void {
|
|
if (abortedFlags.get(signal) !== false) {
|
|
return;
|
|
}
|
|
|
|
abortedFlags.set(signal, true);
|
|
signal.notify({ eventName: 'abort', type: 'abort' });
|
|
}
|
|
|
|
/**
|
|
* Aborted flag for each instances.
|
|
*/
|
|
const abortedFlags = new WeakMap<AbortSignal, boolean>();
|
|
|
|
// Properties should be enumerable.
|
|
Object.defineProperties(AbortSignal.prototype, {
|
|
aborted: { enumerable: true },
|
|
});
|
|
|
|
// `toString()` should return `"[object AbortSignal]"`
|
|
if (typeof Symbol === 'function' && typeof Symbol.toStringTag === 'symbol') {
|
|
Object.defineProperty(AbortSignal.prototype, Symbol.toStringTag, {
|
|
configurable: true,
|
|
value: 'AbortSignal',
|
|
});
|
|
}
|