@threadplane/coreInterfacev0.0.0

ThreadDirectory

Unpublished development API. This package is under development and is not available as a published release.

A framework-neutral directory of threads. Mutations are optional; a directory that cannot perform one leaves the command undefined, and callers offer no control for it.

import type { ThreadDirectory } from '@threadplane/core';

Declaration

export interface ThreadDirectory  {
  create?(options?: {
        readonly metadata?: {
            readonly [key: string]: PlainValue;
        };
        readonly signal?: AbortSignal;
    }): Promise<{
        readonly id: string;
    }>;
  createProject?(name: string): Promise<{
        readonly id: string;
    }>;
  dispose(): void;
  getSnapshot(): ThreadDirectorySnapshot;
  refresh(options?: {
        readonly signal?: AbortSignal;
    }): Promise<void>;
  remove?(id: string): Promise<void>;
  removeProject?(id: string): Promise<void>;
  rename?(id: string, title: string): Promise<void>;
  renameProject?(id: string, name: string): Promise<void>;
  reorderPinned?(id: string, beforeId: string | null): Promise<void>;
  setArchived?(id: string, archived: boolean): Promise<void>;
  setPinned?(id: string, pinned: boolean): Promise<void>;
  setProject?(id: string, projectId: string | null): Promise<void>;
  subscribe(notify: () => void): () => void;
}

Members

create · overload 1

create?(options?: {
        readonly metadata?: {
            readonly [key: string]: PlainValue;
        };
        readonly signal?: AbortSignal;
    }): Promise<{
        readonly id: string;
    }>;

Parameters

options · optional
{ readonly metadata?: { readonly [key: string]: PlainValue; }; readonly signal?: AbortSignal; }

Returns

Promise<{ readonly id: string; }>

createProject · overload 1

createProject?(name: string): Promise<{
        readonly id: string;
    }>;

Parameters

name · required
string

Returns

Promise<{ readonly id: string; }>

dispose · overload 1

dispose(): void;

Returns

void

getSnapshot · overload 1

getSnapshot(): ThreadDirectorySnapshot;

Returns

ThreadDirectorySnapshot

refresh · overload 1

refresh(options?: {
        readonly signal?: AbortSignal;
    }): Promise<void>;

Parameters

options · optional
{ readonly signal?: AbortSignal; }

Returns

Promise<void>

remove · overload 1

remove?(id: string): Promise<void>;

Parameters

id · required
string

Returns

Promise<void>

removeProject · overload 1

removeProject?(id: string): Promise<void>;

Parameters

id · required
string

Returns

Promise<void>

rename · overload 1

rename?(id: string, title: string): Promise<void>;

Parameters

id · required
string
title · required
string

Returns

Promise<void>

renameProject · overload 1

renameProject?(id: string, name: string): Promise<void>;

Parameters

id · required
string
name · required
string

Returns

Promise<void>

reorderPinned · overload 1

reorderPinned?(id: string, beforeId: string | null): Promise<void>;

Parameters

id · required
string
beforeId · required
string | null

Returns

Promise<void>

setArchived · overload 1

setArchived?(id: string, archived: boolean): Promise<void>;

Parameters

id · required
string
archived · required
boolean

Returns

Promise<void>

setPinned · overload 1

setPinned?(id: string, pinned: boolean): Promise<void>;

Parameters

id · required
string
pinned · required
boolean

Returns

Promise<void>

setProject · overload 1

setProject?(id: string, projectId: string | null): Promise<void>;

Parameters

id · required
string
projectId · required
string | null

Returns

Promise<void>

subscribe · overload 1

Changes only. Read the initial aggregate through getSnapshot.

subscribe(notify: () => void): () => void;

Parameters

notify · required
() => void

Returns

() => void