Skip to content
Effect 4.0 is here. One ecosystem. Zero dependencies.

Clipboard

9 exports Since v1.0.0 Source

Constructor

Since v1.0.0

Signature

declare function make(impl: Omit<Clipboard, "clear" | "writeBlob" | TypeId>): Clipboard

Errors

Signature

declare class ClipboardError extends any {
constructor();
}

Interface

Clipboard

interface
Since v1.0.0

Signature

interface Clipboard {
readonly [TypeId]: typeof TypeId;
readonly clear: Effect<void, ClipboardError>;
readonly read: Effect<ClipboardItems, ClipboardError>;
readonly readString: Effect<string, ClipboardError>;
readonly write: (items: ClipboardItems) => Effect<void, ClipboardError>;
readonly writeBlob: (blob: Blob) => Effect<void, ClipboardError>;
readonly writeString: (text: string) => Effect<void, ClipboardError>;
}

Layers

Since v1.0.0

A layer that directly interfaces with the navigator.clipboard api

Signature

declare const layer: Layer.Layer<Clipboard>

Tag

Signature

declare const Clipboard: Tag<Clipboard, Clipboard>

Type Ids

Signature

declare const ErrorTypeId: unique symbol
Since v1.0.0

Signature

type ErrorTypeId = typeof ErrorTypeId
Since v1.0.0

Signature

declare const TypeId: unique symbol
Since v1.0.0

Signature

type TypeId = typeof TypeId