Methods
add
- add<Data>(sheetName: string, key: string, data: Data): unknown
-
Type parameters
Parameters
-
sheetName: string
-
key: string
-
data: Data
Returns unknown
all
- all<Item>(sheetName: string): Item[]
-
Type parameters
Parameters
Returns Item[]
data
- data<Item>(sheetName: string): {}
-
Type parameters
Parameters
Returns {}
docsContent
-
Parameters
Returns string
getLocalDatabase
- getLocalDatabase(sheetName?: undefined | string): Record<string, unknown>
-
Parameters
-
Optional sheetName: undefined | string
Returns Record<string, unknown>
getSpreadsheet
- getSpreadsheet(): Spreadsheet
increase
- increase(sheetName: string, key: string, increasing: string | string[] | {}): Record<string, unknown>
-
Parameters
-
sheetName: string
-
key: string
-
increasing: string | string[] | {}
Returns Record<string, unknown>
item
- item<Item>(sheetName: string, finder: string | number | Filter<Item>, segment?: DataSegment): Item
-
Type parameters
-
Item: Record<string, unknown>
Parameters
-
sheetName: string
-
finder: string | number | Filter<Item>
-
Returns Item
items
-
Type parameters
-
Item: Record<string, unknown>
Parameters
-
sheetName: string
-
Optional filter: Filter<Item>
-
-
Returns Item[]
query
-
Type parameters
-
Item: Record<string, unknown>
Parameters
-
sheetName: string
-
filter: Filter<Item>
-
-
Returns Item[]
ref
-
Parameters
-
Default value path: string = "/"
remove
- remove(sheetName: string, key: string): unknown
-
Parameters
-
sheetName: string
-
key: string
Returns unknown
set
- set<Data>(sheetName: string, key: string, data: Data): unknown
-
Type parameters
Parameters
-
sheetName: string
-
key: string
-
data: Data
Returns unknown
setLocalDatabase
- setLocalDatabase(sheetName: string, items: Record<string, unknown>): Record<string, unknown>
-
Parameters
-
sheetName: string
-
items: Record<string, unknown>
Returns Record<string, unknown>
update
- update<Data>(sheetName: string, key: string, data: Data): unknown
-
Type parameters
Parameters
-
sheetName: string
-
key: string
-
data: Data
Returns unknown