@jbrowse/core 2.16.1 → 2.18.0

package/rpc/remoteAbortSignals.d.ts

@@ -1,36 +0,0 @@
-export interface RemoteAbortSignal {
-    abortSignalId: number;
-}
-/**
- * assign an ID to the given abort signal and return a plain object
- * representation
- *
- * @param signal - the signal to serialize
- * @param callfunc - function used to call
- *  a remote method, will be called like callfunc('signalAbort', signalId)
- */
-export declare function serializeAbortSignal(signal: AbortSignal, callfunc: (name: string, abortSignalId: number) => void): RemoteAbortSignal;
-/**
- * test whether a given object
- * @param thing - the thing to test
- * @returns true if the thing is a remote abort signal
- */
-export declare function isRemoteAbortSignal(thing: unknown): thing is RemoteAbortSignal;
-/**
- * deserialize the result of serializeAbortSignal into an AbortSignal
- *
- * @param signal -
- * @returns an abort signal that corresponds to the given ID
- */
-export declare function deserializeAbortSignal({ abortSignalId, }: RemoteAbortSignal): AbortSignal;
-/**
- * fire an abort signal from a remote abort signal ID
- *
- * @param abortSignalId -
- */
-export declare function remoteAbort(props: {
-    signalId: number;
-}): void;
-export declare function remoteAbortRpcHandler(): {
-    signalAbort: typeof remoteAbort;
-};

package/rpc/remoteAbortSignals.js

@@ -1,79 +0,0 @@
-"use strict";
-/* ---------------- for the RPC client ----------------- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeAbortSignal = serializeAbortSignal;
-exports.isRemoteAbortSignal = isRemoteAbortSignal;
-exports.deserializeAbortSignal = deserializeAbortSignal;
-exports.remoteAbort = remoteAbort;
-exports.remoteAbortRpcHandler = remoteAbortRpcHandler;
-let abortSignalCounter = 0;
-const abortSignalIds = new WeakMap(); // map of abortsignal => numerical ID
-/**
- * assign an ID to the given abort signal and return a plain object
- * representation
- *
- * @param signal - the signal to serialize
- * @param callfunc - function used to call
- *  a remote method, will be called like callfunc('signalAbort', signalId)
- */
-function serializeAbortSignal(signal, callfunc) {
-    let abortSignalId = abortSignalIds.get(signal);
-    if (!abortSignalId) {
-        abortSignalCounter += 1;
-        abortSignalIds.set(signal, abortSignalCounter);
-        abortSignalId = abortSignalCounter;
-        signal.addEventListener('abort', () => {
-            const signalId = abortSignalIds.get(signal);
-            if (signalId !== undefined) {
-                callfunc('signalAbort', signalId);
-            }
-        });
-    }
-    return { abortSignalId };
-}
-/* ---------------- for the RPC server ----------------- */
-/**
- * test whether a given object
- * @param thing - the thing to test
- * @returns true if the thing is a remote abort signal
- */
-function isRemoteAbortSignal(thing) {
-    return (typeof thing === 'object' &&
-        thing !== null &&
-        'abortSignalId' in thing &&
-        typeof thing.abortSignalId === 'number');
-}
-// the server side keeps a set of surrogate abort controllers that can be
-// aborted based on ID
-const surrogateAbortControllers = new Map(); // numerical ID => surrogate abort controller
-/**
- * deserialize the result of serializeAbortSignal into an AbortSignal
- *
- * @param signal -
- * @returns an abort signal that corresponds to the given ID
- */
-function deserializeAbortSignal({ abortSignalId, }) {
-    let surrogateAbortController = surrogateAbortControllers.get(abortSignalId);
-    if (!surrogateAbortController) {
-        surrogateAbortController = new AbortController();
-        surrogateAbortControllers.set(abortSignalId, surrogateAbortController);
-    }
-    return surrogateAbortController.signal;
-}
-/**
- * fire an abort signal from a remote abort signal ID
- *
- * @param abortSignalId -
- */
-function remoteAbort(props) {
-    const { signalId: abortSignalId } = props;
-    const surrogateAbortController = surrogateAbortControllers.get(abortSignalId);
-    if (surrogateAbortController) {
-        surrogateAbortController.abort();
-    }
-}
-function remoteAbortRpcHandler() {
-    return {
-        signalAbort: remoteAbort,
-    };
-}