ClipboardAPI
Defined in: namespaces.ts:699
System pasteboard access plus the fn-91 Core Clipboard engine (history search + Context Bundles + registration sub-bridges).
v1 QUIRKS: sources.register and destinations.register are
DECLARATIVE-ONLY (metadata registration; no executable callback), and
clipboard.contentType contributions are manifest-only (no JS bridge).
Read-shaped cross-plugin denials degrade gracefully ([] / null);
write/export-shaped denials throw sanitized unknownRef.
Properties
Section titled “Properties”history
Section titled “history”history:
object
Defined in: namespaces.ts:712
Clipboard history engine (fn-91).
query()
Section titled “query()”query(
filter):Promise<ClipItem[]>
Queries history. [clipboard.history.read]
Parameters
Section titled “Parameters”filter
Section titled “filter”unknown
Returns
Section titled “Returns”Promise<ClipItem[]>
get(
id):Promise<ClipItem|null>
Gets a clip, or null. [clipboard.history.read]
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<ClipItem | null>
subscribe()
Section titled “subscribe()”subscribe(
handler):Promise<{cancel:Promise<void>; }>
Subscribes to capture events. [clipboard.history.subscribe]
Parameters
Section titled “Parameters”handler
Section titled “handler”(clip) => void
Returns
Section titled “Returns”Promise<{ cancel: Promise<void>; }>
delete()
Section titled “delete()”delete(
id):Promise<boolean>
Deletes a clip. [clipboard.history.write]
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
favorite()
Section titled “favorite()”favorite(
id,isFavorite):Promise<void>
Sets the favorite flag. [clipboard.history.write]
Parameters
Section titled “Parameters”string
isFavorite
Section titled “isFavorite”boolean
Returns
Section titled “Returns”Promise<void>
tag(
id,tags):Promise<void>
Replaces the tag set. [clipboard.history.write]
Parameters
Section titled “Parameters”string
string[]
Returns
Section titled “Returns”Promise<void>
bundles
Section titled “bundles”bundles:
object
Defined in: namespaces.ts:728
Context Bundles (fn-91). All methods require [clipboard.bundles].
create()
Section titled “create()”create(
name):Promise<ClipboardContextBundle>
Creates a bundle.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<ClipboardContextBundle>
update()
Section titled “update()”update(
bundle):Promise<ClipboardContextBundle>
Updates a bundle.
Parameters
Section titled “Parameters”bundle
Section titled “bundle”Returns
Section titled “Returns”Promise<ClipboardContextBundle>
addClip()
Section titled “addClip()”addClip(
bundleId,clipId,notes?):Promise<void>
Adds a clip to a bundle.
Parameters
Section titled “Parameters”bundleId
Section titled “bundleId”string
clipId
Section titled “clipId”string
notes?
Section titled “notes?”string
Returns
Section titled “Returns”Promise<void>
removeClip()
Section titled “removeClip()”removeClip(
bundleId,clipId):Promise<void>
Removes a clip from a bundle.
Parameters
Section titled “Parameters”bundleId
Section titled “bundleId”string
clipId
Section titled “clipId”string
Returns
Section titled “Returns”Promise<void>
export()
Section titled “export()”export(
bundleId,format):Promise<unknown>
Exports a bundle (“markdown” | “json” | “xml” | “plainText”).
Parameters
Section titled “Parameters”bundleId
Section titled “bundleId”string
format
Section titled “format”string
Returns
Section titled “Returns”Promise<unknown>
list()
Section titled “list()”list():
Promise<ClipboardContextBundle[]>
Lists own bundles.
Returns
Section titled “Returns”Promise<ClipboardContextBundle[]>
get(
bundleId):Promise<ClipboardContextBundle|null>
Gets a bundle.
Parameters
Section titled “Parameters”bundleId
Section titled “bundleId”string
Returns
Section titled “Returns”Promise<ClipboardContextBundle | null>
delete()
Section titled “delete()”delete(
bundleId):Promise<void>
Deletes a bundle.
Parameters
Section titled “Parameters”bundleId
Section titled “bundleId”string
Returns
Section titled “Returns”Promise<void>
transforms
Section titled “transforms”transforms:
object
Defined in: namespaces.ts:748
Transform contributors. [clipboard.transform.register]
register()
Section titled “register()”register(
definition,handler):Promise<{cancel:Promise<void>; }>
Parameters
Section titled “Parameters”definition
Section titled “definition”unknown
handler
Section titled “handler”(clip) => unknown
Returns
Section titled “Returns”Promise<{ cancel: Promise<void>; }>
rules:
object
Defined in: namespaces.ts:752
Capture-rule contributors. [clipboard.rule.register]
register()
Section titled “register()”register(
definition,handler):Promise<{cancel:Promise<void>; }>
Parameters
Section titled “Parameters”definition
Section titled “definition”unknown
handler
Section titled “handler”(clip) => unknown
Returns
Section titled “Returns”Promise<{ cancel: Promise<void>; }>
retentionPredicates
Section titled “retentionPredicates”retentionPredicates:
object
Defined in: namespaces.ts:756
Retention-predicate contributors. [clipboard.retention.predicate.register]
register()
Section titled “register()”register(
definition,predicate):Promise<{cancel:Promise<void>; }>
Parameters
Section titled “Parameters”definition
Section titled “definition”unknown
predicate
Section titled “predicate”(clip) => boolean | Promise<boolean>
Returns
Section titled “Returns”Promise<{ cancel: Promise<void>; }>
sources
Section titled “sources”sources:
object
Defined in: namespaces.ts:760
Source contributors — DECLARATIVE-ONLY in v1. [clipboard.source.register]
register()
Section titled “register()”register(
definition):Promise<{cancel:Promise<void>; }>
Parameters
Section titled “Parameters”definition
Section titled “definition”unknown
Returns
Section titled “Returns”Promise<{ cancel: Promise<void>; }>
destinations
Section titled “destinations”destinations:
object
Defined in: namespaces.ts:764
Destination contributors — DECLARATIVE-ONLY in v1. [clipboard.destination.register]
register()
Section titled “register()”register(
definition):Promise<{cancel:Promise<void>; }>
Parameters
Section titled “Parameters”definition
Section titled “definition”unknown
Returns
Section titled “Returns”Promise<{ cancel: Promise<void>; }>
Methods
Section titled “Methods”read()
Section titled “read()”read():
Promise<string|null>
Defined in: namespaces.ts:701
Reads the current clipboard string content. [clipboard.read]
Returns
Section titled “Returns”Promise<string | null>
write()
Section titled “write()”write(
text):Promise<boolean>
Defined in: namespaces.ts:703
Clears the clipboard and writes the given string. [clipboard.write]
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
paste()
Section titled “paste()”paste(
clipId,destinationId):Promise<unknown>
Defined in: namespaces.ts:705
Pastes a history clip into a registered destination. [clipboard.history.read]
Parameters
Section titled “Parameters”clipId
Section titled “clipId”string
destinationId
Section titled “destinationId”string
Returns
Section titled “Returns”Promise<unknown>
listDestinations()
Section titled “listDestinations()”listDestinations():
Promise<ClipDestination[]>
Defined in: namespaces.ts:707
Lists registered paste destinations.
Returns
Section titled “Returns”Promise<ClipDestination[]>
ingest()
Section titled “ingest()”ingest(
kind,content,metadata?):Promise<ClipItem>
Defined in: namespaces.ts:709
Ingests content into history programmatically. [clipboard.history.write]
Parameters
Section titled “Parameters”string
content
Section titled “content”unknown
metadata?
Section titled “metadata?”Record<string, unknown>
Returns
Section titled “Returns”Promise<ClipItem>