Archives/gristlabs_grist-core
1
0
Fork 0
mirror of https://github.com/gristlabs/grist-core.git synced 2026-03-02 04:09:24 +00:00
Code Issues Projects Releases Wiki Activity

(core) configure typedoc for generating plugin api documentation

Browse Source 
Summary:
This annotates the plugin api sufficiently to generate some documentation
for it. See https://github.com/gristlabs/grist-help/pull/139

Contains some small code tweaks for things that caused typedoc some
trouble.

Test Plan: manual inspection of output

Reviewers: jarek

Reviewed By: jarek

Differential Revision: https://phab.getgrist.com/D3342
This commit is contained in:
Paul Fitzpatrick
2022-03-23 09:41:34 -04:00
parent d8af25de9d
commit c6d66e15bf
8 changed files with 178 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
app/plugin/TableOperations.ts
View File

@@ -4,22 +4,32 @@ import * as Types from 'app/plugin/DocApiTypes';
* Offer CRUD-style operations on a table.
*/
export interface TableOperations {
// Create a record or records.
/**
* Create a record or records.
*/
create(records: Types.NewRecord, options?: OpOptions): Promise<Types.MinimalRecord>;
create(records: Types.NewRecord[], options?: OpOptions): Promise<Types.MinimalRecord[]>;
// Update a record or records.
/**
* Update a record or records.
*/
update(records: Types.Record|Types.Record[], options?: OpOptions): Promise<void>;
// Delete a record or records.
/**
* Delete a record or records.
*/
destroy(recordId: Types.RecordId): Promise<Types.RecordId>;
destroy(recordIds: Types.RecordId[]): Promise<Types.RecordId[]>;
// Add or update a record or records.
/**
* Add or update a record or records.
*/
upsert(records: Types.AddOrUpdateRecord|Types.AddOrUpdateRecord[],
options?: UpsertOptions): Promise<void>;
// Determine the tableId of the table.
/**
* Determine the tableId of the table.
*/
getTableId(): Promise<string>;
// TODO: offer a way to query the table.
@@ -32,7 +42,7 @@ export interface TableOperations {
* This can be disabled.
*/
export interface OpOptions {
parseStrings?: boolean;
parseStrings?: boolean; /** whether to parse strings based on the column type. */
}
/**
@@ -40,8 +50,8 @@ export interface OpOptions {
* onMany is first, and allowEmptyRequire is false.
*/
export interface UpsertOptions extends OpOptions {
add?: boolean; // permit inserting a record
update?: boolean; // permit updating a record
onMany?: 'none' | 'first' | 'all'; // whether to update none, one, or all matching records
allowEmptyRequire?: boolean; // allow "wildcard" operation
add?: boolean; /** permit inserting a record */
update?: boolean; /** permit updating a record */
onMany?: 'none' | 'first' | 'all'; /** whether to update none, one, or all matching records */
allowEmptyRequire?: boolean; /** allow "wildcard" operation */
}