@kody/stash

src/archive.ts

15 lines · 551 B · TypeScript
import { archiveNote } from './lib/notes.ts'
export { archiveNote }

/**
 * Archive a stash note so it is excluded from default search and recent lists.
 *
 * @param input.dryRun - When true, preview the archive without writing storage.
 * @example
 * import archiveNote from 'kody:@kody/stash/archive'
 * const result = await archiveNote({ id: 'note-uuid', dryRun: true })
 * // => { ok: true, dryRun: true, id: 'note-uuid', archivedAt: '...' }
 */
export default async function archiveStashNote(input?: unknown) {
	return await archiveNote(input)
}