类型与错误

下列为辅助数据类型。错误码表示失败类别，不代表每个方法都可能返回所有错误。权限和生命周期由宿主检查。失败时保留用户输入，不要盲目重试非幂等写入。文本编辑的 stale 和保存的 conflict 是返回状态，不是错误码。导入的 Eidos 数据类型属于 @eidos.space/eidos-file，DOM 与 ECMAScript 类型使用其标准定义。

使用指南: files. API 索引.

签名、参数及返回类型从 SDK 自动生成；可选成员不保证在每个宿主和上下文中存在。

PluginIconDefinition

源码

export type PluginIconDefinition = string | {
    paths: string[];
} | {
    src: string;
} | {
    file: string;
};

ResourceSource

源码

export type ResourceSource = {
    kind: "file";
    path: string;
    editor?: string;
} | {
    kind: "eidos-view";
    path: string;
    tableId: string;
    viewId: string;
};

ResourceViewInfo

源码

export type ResourceViewInfo = {
    kind: "file";
    editor: string;
    name: string;
    type: string;
} | {
    kind?: "eidos-view";
    tableId: string;
    tableName: string;
    viewId: string;
    name: string;
    type: string;
};

ViewCapability

源码

export type ViewCapability = "document" | "eidos/schema" | "eidos/table" | "eidos/config";

FileHookEventType

源码

export type FileHookEventType = "document.saved" | "file.renamed";

FileHookEvent

源码

FileHookEvent.type

type: FileHookEventType;

FileHookEvent.operationId

operationId: string;

FileHookEvent.source

source: "local" | "plugin" | "sync";

FileHookEvent.path

path: string;

FileHookEvent.previousPath

previousPath?: string;

FileHookEvent.previousText

previousText?: string;

FileHookEvent.document

document: {
    text: string;
    version: string;
};

关联类型: FileHookEventType.

FileHookPlan

源码

FileHookPlan.text

text?: string;

FileHookPlan.name

name?: string;

FormatterInput

源码

FormatterInput.text

text: string;

FormatterInput.path

path: string;

FormatterInput.signal

signal: AbortSignal;

Disposable

源码

Disposable.dispose

dispose(): void;

返回值: void.

BackgroundMessage

源码

export type BackgroundMessage = null | boolean | number | string | BackgroundMessage[] | {
    [key: string]: BackgroundMessage;
};

FileStat

源码

FileStat.path

readonly path: string;

FileStat.name

readonly name: string;

FileStat.extension

readonly extension: string;

FileStat.size

readonly size: number;

FileStat.isDirectory

readonly isDirectory: boolean;

FileStat.modifiedAtMs

readonly modifiedAtMs?: number;

FileListOptions

源码

FileListOptions.extensions

extensions?: string[];

FileListOptions.recursive

recursive?: boolean;

FileListOptions.includeDirectories

includeDirectories?: boolean;

FileMetaValue

源码

export type FileMetaValue = null | string | number | boolean | FileMetaValue[] | {
    [key: string]: FileMetaValue;
};

FileMetaValues

源码

export type FileMetaValues = Record<string, FileMetaValue>;

关联类型: FileMetaValue.

FileMetaPatch

源码

FileMetaPatch.set

set?: FileMetaValues;

FileMetaPatch.remove

remove?: string[];

关联类型: FileMetaValues.

ExplorerState

源码

ExplorerState.rootDirectory

rootDirectory: string | null;

ExplorerState.activePath

activePath: string | null;

ExplorerState.sort

sort: {
    by: "name" | "modified" | "type";
    direction: "ascending" | "descending";
};

FileMetadata

源码

FileMetadata.path

readonly path: string;

FileMetadata.name

readonly name: string;

FileMetadata.baseName

readonly baseName: string;

FileMetadata.extension

readonly extension: string;

FileMetadata.mimeType

readonly mimeType?: string;

FileMetadata.size

readonly size: number;

FileRef

源码

interface FileRef extends Partial<FileMetadata> { /* members below */ }

FileRef.id

readonly id: string;

关联类型: FileMetadata.

ViewBinding

源码

export type ViewBinding = {
    kind: "page";
    route: string;
} | {
    kind: "file";
    file: FileRef;
    location?: {
        kind: "eidos-table";
        tableId: string;
        viewId: string;
    };
};

关联类型: FileRef.

ActionBinding

源码

export type ActionBinding = {
    kind: "workspace";
} | {
    kind: "file";
    file: FileRef;
};

关联类型: FileRef.

TableActionItem

源码

TableActionItem.id

id: string;

TableActionItem.title

title: string;

TableActionItem.icon

icon?: {
    paths: string[];
};

TableActionItem.targets

targets: Array<"row" | "selection" | "view">;

TableActionRecord

源码

TableActionRecord.id

id: string;

TableActionRecord.values

values: Record<string, LogicalValue>;

TableActionRecord.readToken

readToken: string;

PluginPackage

源码

PluginPackage.format

format: 1 | 2 | 3;

PluginPackage.manifest

manifest: PluginManifest;

PluginPackage.modules

modules: Record<string, string>;

PluginPackage.resources

resources?: Record<string, string>;

关联类型: PluginManifest.

TextSnapshot

源码

TextSnapshot.text

text: string;

TextSnapshot.version

version: string;

TextSnapshot.encoding

encoding: "utf-8" | "utf-16le" | "utf-16be";

TextSnapshot.bom

bom: boolean;

TextSnapshot.dirty

dirty: boolean;

TextSnapshot.conflicted

conflicted: boolean;

EidosConfigSnapshot

源码

EidosConfigSnapshot.value

value: JsonObject | null;

EidosConfigSnapshot.version

version: string;

EidosTableSnapshot

源码

EidosTableSnapshot.fields

fields: EidosFileFieldInfo[];

EidosTableSnapshot.view

view: EidosFileViewInfo;

TableAggregateMetric

源码

export type TableAggregateMetric = "count" | "sum" | "average" | "min" | "max";

TableAggregateDateInterval

源码

export type TableAggregateDateInterval = "exact" | "day" | "month" | "year";

TableAggregateOptions

源码

TableAggregateOptions.groupBy

groupBy?: {
    fieldId: string;
    dateInterval?: TableAggregateDateInterval;
};

TableAggregateOptions.metric

metric: {
    fieldId?: string;
    op: TableAggregateMetric;
};

TableAggregateOptions.sort

sort?: "label" | "value-desc" | "value-asc";

关联类型: TableAggregateDateInterval, TableAggregateMetric.

TableAggregateItem

源码

TableAggregateItem.key

key: unknown;

TableAggregateItem.label

label: string;

TableAggregateItem.value

value: number;

TableAggregateResult

源码

TableAggregateResult.items

items: TableAggregateItem[];

TableAggregateResult.totalRecords

totalRecords: number;

关联类型: TableAggregateItem.

SettingValue

源码

export type SettingValue = boolean | string | number;

FileExportRequest

源码

FileExportRequest.name

name: string;

FileExportRequest.mimeType

mimeType: string;

FileExportRequest.data

data: Uint8Array;

FileExportResult

源码

export type FileExportResult = {
    status: "saved" | "download-started" | "cancelled";
};

ObserverErrorHandler

源码

export type ObserverErrorHandler = (error: {
    code: string;
    message: string;
}) => void;

PluginErrorCode

源码

export type PluginErrorCode = "INVALID_REQUEST" | "UNSUPPORTED_API" | "PERMISSION_DENIED" | "DOCUMENT_UNAVAILABLE" | "INSTANCE_CLOSED" | "STALE_REVISION" | "ALREADY_EXISTS" | "BUSY" | "TOO_LARGE" | "IO_ERROR" | "TIMEOUT" | "CANCELLED" | "REGISTRATION_CONFLICT" | "DEPENDENCY_MISSING" | "SOURCE_INVALID";