02f4e27b53
* Only test against TypeScript 4.7 * Move type definitions to entrypoints/ Only TS 4.7 will resolve them now, but it's cleaner. * Use @sindresorhus/tsconfig * Fix test TypeScript files, make compilable and lintable * Use tsc directly, instead of tsd * Add *.cts versions of type tests * Reorganize type tests * Use tsc directly, avoid npx, print actual version Somehow `npx tsc` was pointing at an older version. Possibly the binstubs are corrupted in CI… somehow.
77 lines
2.4 KiB
TypeScript
77 lines
2.4 KiB
TypeScript
import {URL} from 'node:url';
|
|
|
|
export namespace SharedWorker {
|
|
export type ProtocolIdentifier = 'ava-4';
|
|
|
|
export type FactoryOptions = {
|
|
negotiateProtocol <Data = unknown>(supported: readonly ['ava-4']): Protocol<Data>;
|
|
// Add overloads for additional protocols.
|
|
};
|
|
|
|
export type Factory = (options: FactoryOptions) => void;
|
|
|
|
export type Protocol<Data = unknown> = {
|
|
readonly initialData: Data;
|
|
readonly protocol: 'ava-4';
|
|
broadcast: (data: Data) => BroadcastMessage<Data>;
|
|
ready: () => Protocol<Data>;
|
|
subscribe: () => AsyncIterableIterator<ReceivedMessage<Data>>;
|
|
testWorkers: () => AsyncIterableIterator<TestWorker<Data>>;
|
|
};
|
|
|
|
export type BroadcastMessage<Data = unknown> = {
|
|
readonly id: string;
|
|
replies: () => AsyncIterableIterator<ReceivedMessage<Data>>;
|
|
};
|
|
|
|
export type PublishedMessage<Data = unknown> = {
|
|
readonly id: string;
|
|
replies: () => AsyncIterableIterator<ReceivedMessage<Data>>;
|
|
};
|
|
|
|
export type ReceivedMessage<Data = unknown> = {
|
|
readonly data: Data;
|
|
readonly id: string;
|
|
readonly testWorker: TestWorker;
|
|
reply: (data: Data) => PublishedMessage<Data>;
|
|
};
|
|
|
|
export type TestWorker<Data = unknown> = {
|
|
readonly id: string;
|
|
readonly file: string;
|
|
publish: (data: Data) => PublishedMessage<Data>;
|
|
subscribe: () => AsyncIterableIterator<ReceivedMessage<Data>>;
|
|
teardown: (fn: (() => Promise<void>) | (() => void)) => () => Promise<void>;
|
|
};
|
|
|
|
export namespace Plugin {
|
|
export type RegistrationOptions<Identifier extends ProtocolIdentifier, Data = unknown> = {
|
|
readonly filename: string | URL;
|
|
readonly initialData?: Data;
|
|
readonly supportedProtocols: readonly Identifier[];
|
|
readonly teardown?: () => void;
|
|
};
|
|
|
|
export type Protocol<Data = unknown> = {
|
|
readonly available: Promise<void>;
|
|
readonly currentlyAvailable: boolean;
|
|
readonly protocol: 'ava-4';
|
|
publish: (data: Data) => PublishedMessage<Data>;
|
|
subscribe: () => AsyncIterableIterator<ReceivedMessage<Data>>;
|
|
};
|
|
|
|
export type PublishedMessage<Data = unknown> = {
|
|
readonly id: string;
|
|
replies: () => AsyncIterableIterator<ReceivedMessage<Data>>;
|
|
};
|
|
|
|
export type ReceivedMessage<Data = unknown> = {
|
|
readonly data: Data;
|
|
readonly id: string;
|
|
reply: (data: Data) => PublishedMessage<Data>;
|
|
};
|
|
}
|
|
}
|
|
|
|
export function registerSharedWorker<Data = unknown>(options: SharedWorker.Plugin.RegistrationOptions<'ava-4', Data>): SharedWorker.Plugin.Protocol<Data>;
|
|
// Add overloads for additional protocols.
|