Clipboard.ts

/**
 * @since 1.0.0
 */

import type { PlatformError } from "@effect/platform/Error"
import type { Tag } from "effect/Context"
import type * as Effect from "effect/Effect"
import type * as Layer from "effect/Layer"
import * as internal from "./internal/clipboard.js"

/**
 * @since 1.0.0
 * @category interface
 */
export interface Clipboard {
  readonly read: Effect.Effect<ClipboardItems, PlatformError>
  readonly readString: Effect.Effect<string, PlatformError>
  readonly write: (items: ClipboardItems) => Effect.Effect<void, PlatformError>
  readonly writeString: (text: string) => Effect.Effect<void, PlatformError>
  readonly writeBlob: (blob: Blob) => Effect.Effect<void, PlatformError>
  readonly clear: Effect.Effect<void, PlatformError>
}

/**
 * @since 1.0.0
 * @category constructor
 */
export const make: (
  impl: Omit<Clipboard, "clear" | "writeBlob">
) => Clipboard = internal.make

/**
 * @since 1.0.0
 * @category tag
 */
export const Clipboard: Tag<Clipboard, Clipboard> = internal.tag

/**
 * A layer that directly interfaces with the navigator.clipboard api
 *
 * @since 1.0.0
 * @category layers
 */
export const layer: Layer.Layer<Clipboard> = internal.layer