mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-10-27 20:44:07 +00:00
aeb7a4b849
Summary: This extends the getAccessToken documentation so it can be picked up by typedoc and published, and makes a few other tweaks along the way prompted by a typescript/typedoc version change. Test Plan: made in concert with a grist-help update Reviewers: jarek Reviewed By: jarek Subscribers: jarek Differential Revision: https://phab.getgrist.com/D3548
96 lines
2.8 KiB
TypeScript
96 lines
2.8 KiB
TypeScript
/**
|
|
* Letter codes for CellValue types encoded as [code, args...] tuples.
|
|
*/
|
|
export enum GristObjCode {
|
|
List = 'L',
|
|
LookUp = 'l',
|
|
Dict = 'O',
|
|
DateTime = 'D',
|
|
Date = 'd',
|
|
Skip = 'S',
|
|
Censored = 'C',
|
|
Reference = 'R',
|
|
ReferenceList = 'r',
|
|
Exception = 'E',
|
|
Pending = 'P',
|
|
Unmarshallable = 'U',
|
|
Versions = 'V',
|
|
}
|
|
|
|
/**
|
|
* Possible types of cell content.
|
|
*/
|
|
export type CellValue = number|string|boolean|null|[GristObjCode, ...unknown[]];
|
|
export interface BulkColValues { [colId: string]: CellValue[]; }
|
|
|
|
/**
|
|
* Map of column ids to `CellValue`s.
|
|
*
|
|
* ### CellValue
|
|
*
|
|
* Each `CellValue` may either be a primitive (e.g. `true`, `123`, `"hello"`, `null`)
|
|
* or a tuple (JavaScript Array) representing a Grist object. The first element of the tuple
|
|
* is a string character representing the object code. For example, `["L", "foo", "bar"]`
|
|
* is a `CellValue` of a Choice List column, where `"L"` is the type, and `"foo"` and
|
|
* `"bar"` are the choices.
|
|
*
|
|
* ### Grist Object Types
|
|
*
|
|
* | Code | Type |
|
|
* | ---- | -------------- |
|
|
* | L | List |
|
|
* | l | LookUp |
|
|
* | O | Dict |
|
|
* | D | DateTime |
|
|
* | d | Date |
|
|
* | C | Censored |
|
|
* | R | Reference |
|
|
* | r | ReferenceList |
|
|
* | E | Exception |
|
|
* | P | Pending |
|
|
* | U | Unmarshallable |
|
|
* | V | Version |
|
|
*/
|
|
export interface RowRecord {
|
|
id: number;
|
|
[colId: string]: CellValue;
|
|
}
|
|
|
|
/**
|
|
* Map of column ids to `CellValue` arrays, where array indexes correspond to
|
|
* rows.
|
|
*
|
|
* ### CellValue
|
|
*
|
|
* Each `CellValue` may either be a primitive (e.g. `true`, `123`, `"hello"`, `null`)
|
|
* or a tuple (JavaScript Array) representing a Grist object. The first element of the tuple
|
|
* is a string character representing the object code. For example, `["L", "foo", "bar"]`
|
|
* is a `CellValue` of a Choice List column, where `"L"` is the type, and `"foo"` and
|
|
* `"bar"` are the choices.
|
|
*
|
|
* ### Grist Object Types
|
|
*
|
|
* | Code | Type |
|
|
* | ---- | -------------- |
|
|
* | L | List |
|
|
* | l | LookUp |
|
|
* | O | Dict |
|
|
* | D | DateTime |
|
|
* | d | Date |
|
|
* | C | Censored |
|
|
* | R | Reference |
|
|
* | r | ReferenceList |
|
|
* | E | Exception |
|
|
* | P | Pending |
|
|
* | U | Unmarshallable |
|
|
* | V | Version |
|
|
*/
|
|
export interface RowRecords {
|
|
id: number[];
|
|
[colId: string]: CellValue[];
|
|
}
|
|
|
|
export type GristType = 'Any' | 'Attachments' | 'Blob' | 'Bool' | 'Choice' | 'ChoiceList' |
|
|
'Date' | 'DateTime' |
|
|
'Id' | 'Int' | 'ManualSortPos' | 'Numeric' | 'PositionNumber' | 'Ref' | 'RefList' | 'Text';
|