Skip to content

Clipboard

9 exports Added in v1.0.0 Source

Constructor

make

Added in v1.0.0 Source

Signature

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

Errors

Signature

declare class ClipboardError extends any {
  constructor();
}

Interface

Clipboard interface

Added in v1.0.0 Source

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

layer

Added in v1.0.0 Source

A layer that directly interfaces with the navigator.clipboard api

Signature

declare const layer: Layer.Layer<Clipboard>;

Tag

Clipboard

Added in v1.0.0 Source

Signature

declare const Clipboard: Tag<Clipboard, Clipboard>;

Type Ids

ErrorTypeId

Added in v1.0.0 Source

Signature

declare const ErrorTypeId: unique symbol;

ErrorTypeId type

Added in v1.0.0 Source

Signature

type ErrorTypeId = typeof ErrorTypeId;

TypeId

Added in v1.0.0 Source

Signature

declare const TypeId: unique symbol;

TypeId type

Added in v1.0.0 Source

Signature

type TypeId = typeof TypeId;