knitting 0.1.55 → 0.1.60

package/shared-memory.d.ts

@@ -1,155 +1 @@
-type SharedBuffer = SharedArrayBuffer | ArrayBuffer;
-type SharedBufferRegion = {
-	sab: SharedBuffer;
-	byteOffset: number;
-	byteLength: number;
-};
-type ConnectionRuntime = "node" | "deno" | "bun";
-type SharedMemoryBuffer = ArrayBuffer | SharedArrayBuffer;
-type SharedMemoryBufferKind = "shared-array-buffer" | "external-array-buffer";
-type SharedMemoryCreateMode = "anonymous" | "create" | "open";
-type SharedMemoryMapping<Buffer extends SharedMemoryBuffer = SharedMemoryBuffer> = {
-	runtime: ConnectionRuntime;
-	fd: number;
-	name?: string;
-	size: number;
-	byteLength: number;
-	buffer: Buffer;
-	kind: SharedMemoryBufferKind;
-	sab?: SharedArrayBuffer;
-	arrayBuffer?: ArrayBuffer;
-	baseAddressMod64?: number;
-	unsafePointer?: unknown;
-	close?: () => void;
-};
-type CreateSharedMemoryOptions = {
-	size: number;
-	/**
-	 * `anonymous` keeps the current fd-backed private mapping behavior.
-	 * `create` and `open` use a named shared-memory object so independent
-	 * processes can rendezvous by name.
-	 */
-	mode?: SharedMemoryCreateMode;
-	name?: string;
-};
-type MapSharedMemoryOptions = {
-	fd: number;
-	name?: string;
-	size: number;
-	duplicateFd?: boolean;
-};
-type SharedMemoryConnectionPrimitives<Mapping extends SharedMemoryMapping = SharedMemoryMapping> = {
-	runtime: ConnectionRuntime;
-	createSharedMemory: (options: number | CreateSharedMemoryOptions) => Mapping;
-	mapSharedMemory: (options: MapSharedMemoryOptions) => Mapping;
-	unlinkSharedMemory?: (name: string) => boolean;
-};
-type FileDescriptorMetadata = {
-	version: 1;
-	fd: number;
-	name?: string;
-	size: number;
-	byteLength: number;
-	runtime?: ConnectionRuntime;
-	kind?: SharedMemoryMapping["kind"];
-	baseAddressMod64?: number;
-};
-type FileDescriptorMapper = Pick<SharedMemoryConnectionPrimitives, "mapSharedMemory">;
-declare class FileDescriptor {
-	#private;
-	readonly fd: number;
-	readonly name?: string;
-	readonly size: number;
-	readonly byteLength: number;
-	readonly runtime?: ConnectionRuntime;
-	readonly kind?: SharedMemoryMapping["kind"];
-	readonly baseAddressMod64?: number;
-	constructor(metadata: FileDescriptorMetadata, mapping?: SharedMemoryMapping);
-	static fromMapping(mapping: SharedMemoryMapping): FileDescriptor;
-	static fromMetadata(metadata: unknown): FileDescriptor;
-	static parse(serialized: string): FileDescriptor;
-	toMetadata(): FileDescriptorMetadata;
-	toJSON(): FileDescriptorMetadata;
-	stringify(): string;
-	stringifyMetadata(): string;
-	toString(): string;
-	attach(mapping: SharedMemoryMapping): this;
-	get mapping(): SharedMemoryMapping | undefined;
-	map(mapper: FileDescriptorMapper): SharedMemoryMapping;
-	getBuffer(mapper?: FileDescriptorMapper): SharedMemoryBuffer;
-	getSharedArrayBuffer(mapper?: FileDescriptorMapper): SharedArrayBuffer;
-	getSAB(mapper?: FileDescriptorMapper): SharedArrayBuffer;
-}
-export type ProcessSharedBufferMetadata = {
-	version: 1;
-	descriptor: FileDescriptorMetadata;
-	byteOffset: number;
-	byteLength: number;
-};
-export declare const PROCESS_SHARED_BUFFER_BRAND: unique symbol;
-declare const PROCESS_SHARED_BUFFER_NUMERIC_TRANSFER: unique symbol;
-declare const EXTERNAL_PAYLOAD_BRAND: unique symbol;
-type ProcessSharedBufferNumericMetadata = readonly [
-	fd: number,
-	size: number,
-	descriptorByteLength: number,
-	byteOffset: number,
-	byteLength: number,
-	runtime: number,
-	kind: number,
-	baseAddressMod64: number
-];
-export type ProcessSharedBufferRange = {
-	byteOffset?: number;
-	byteLength?: number;
-};
-export type ProcessSharedBufferCreator = Pick<SharedMemoryConnectionPrimitives, "createSharedMemory">;
-export type ProcessSharedBufferMapper = Pick<SharedMemoryConnectionPrimitives, "mapSharedMemory">;
-export type ProcessSharedBufferPrimitives = Pick<SharedMemoryConnectionPrimitives, "createSharedMemory" | "mapSharedMemory"> & {
-	unlinkSharedMemory?: (name: string) => boolean;
-};
-export type ProcessSharedBufferView = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | BigInt64Array | BigUint64Array | Float32Array | Float64Array;
-export type ProcessSharedBufferViewConstructor<View extends ProcessSharedBufferView = ProcessSharedBufferView> = {
-	readonly BYTES_PER_ELEMENT: number;
-	new (buffer: SharedBuffer, byteOffset: number, length: number): View;
-};
-export declare const setDefaultProcessSharedBufferPrimitives: (primitives: ProcessSharedBufferPrimitives | undefined) => void;
-export declare const getDefaultProcessSharedBufferPrimitives: () => ProcessSharedBufferPrimitives;
-/**
- * Zero-copy shared bytes for process workers.
- *
- * Use this when the boundary is a separate process, container, or sandbox.
- * For thread workers, `SharedArrayBuffer` or `BufferReference` can be cheaper.
- */
-export declare class ProcessSharedBuffer {
-	readonly [PROCESS_SHARED_BUFFER_BRAND] = true;
-	readonly [EXTERNAL_PAYLOAD_BRAND] = "knitting.processSharedBuffer";
-	readonly descriptor: FileDescriptor;
-	readonly byteOffset: number;
-	readonly byteLength: number;
-	constructor(descriptor: FileDescriptor, range?: ProcessSharedBufferRange);
-	static create(options: number | CreateSharedMemoryOptions, creator?: ProcessSharedBufferCreator): ProcessSharedBuffer;
-	static fromMapping(mapping: SharedMemoryMapping): ProcessSharedBuffer;
-	static fromDescriptor(descriptor: FileDescriptor, range?: ProcessSharedBufferRange): ProcessSharedBuffer;
-	static fromMetadata(metadata: unknown): ProcessSharedBuffer;
-	static parse(serialized: string): ProcessSharedBuffer;
-	static [PROCESS_SHARED_BUFFER_NUMERIC_TRANSFER](metadata: ProcessSharedBufferNumericMetadata): ProcessSharedBuffer;
-	get fd(): number;
-	get size(): number;
-	subbuffer(byteOffset: number, byteLength?: number): ProcessSharedBuffer;
-	getSharedArrayBuffer(mapper?: ProcessSharedBufferMapper): SharedArrayBuffer;
-	getSAB(mapper?: ProcessSharedBufferMapper): SharedArrayBuffer;
-	getBuffer(mapper?: ProcessSharedBufferMapper): SharedBuffer;
-	getRegion(mapper?: ProcessSharedBufferMapper): SharedBufferRegion;
-	view<View extends ProcessSharedBufferView>(constructor: ProcessSharedBufferViewConstructor<View>, mapper?: ProcessSharedBufferMapper): View;
-	bytes(mapper?: ProcessSharedBufferMapper): Uint8Array;
-	dataView(mapper?: ProcessSharedBufferMapper): DataView;
-	toMetadata(): ProcessSharedBufferMetadata;
-	toJSON(): ProcessSharedBufferMetadata;
-	stringify(): string;
-	stringifyMetadata(): string;
-	toString(): string;
-}
-export declare const parseProcessSharedBufferMetadata: (input: unknown) => ProcessSharedBufferMetadata;
-
-export {};
+export { getDefaultProcessSharedBufferPrimitives, parseProcessSharedBufferMetadata, PROCESS_SHARED_BUFFER_BRAND, ProcessSharedBuffer, setDefaultProcessSharedBufferPrimitives, type ProcessSharedBufferCreator, type ProcessSharedBufferMapper, type ProcessSharedBufferMetadata, type ProcessSharedBufferPrimitives, type ProcessSharedBufferRange, type ProcessSharedBufferView, type ProcessSharedBufferViewConstructor, } from "./src/connections/process-shared-buffer.js";