Clipboard.ts overview

Since v1.0.0

Exports Grouped by Category

constructor

make

Signature

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

Source

Since v1.0.0

errors

ClipboardError (class)

Signature

declare class ClipboardError

Source

Since v1.0.0

interface

Clipboard (interface)

Signature

export interface Clipboard {
  readonly [TypeId]: TypeId

  readonly read: Effect.Effect<ClipboardItems, ClipboardError>
  readonly readString: Effect.Effect<string, ClipboardError>
  readonly write: (items: ClipboardItems) => Effect.Effect<void, ClipboardError>
  readonly writeString: (text: string) => Effect.Effect<void, ClipboardError>
  readonly writeBlob: (blob: Blob) => Effect.Effect<void, ClipboardError>
  readonly clear: Effect.Effect<void, ClipboardError>
}

Source

Since v1.0.0

layers

layer

A layer that directly interfaces with the navigator.clipboard api

Signature

declare const layer: Layer.Layer<Clipboard, never, never>

Source

Since v1.0.0

tag

Clipboard

Signature

declare const Clipboard: Context.Tag<Clipboard, Clipboard>

Source

Since v1.0.0

type ids

ErrorTypeId

Signature

declare const ErrorTypeId: unique symbol

Source

Since v1.0.0

ErrorTypeId (type alias)

Signature

type ErrorTypeId = typeof ErrorTypeId

Source

Since v1.0.0

TypeId

Signature

declare const TypeId: unique symbol

Source

Since v1.0.0

TypeId (type alias)

Signature

type TypeId = typeof TypeId

Source

Since v1.0.0