clone/logseq
1
0
Fork 0
mirror of https://github.com/logseq/logseq.git synced 2026-04-24 22:25:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

enhance(plugin): api types for the property entity

Browse Source
This commit is contained in:
charlie
2024-09-05 17:12:17 +08:00
parent dbfdf86021
commit fccef5e904
2 changed files with 32 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
libs/src/LSPlugin.ts
View File

@@ -798,6 +798,26 @@ export interface IEditorProxy extends Record<string, any> {
saveFocusedCodeEditorContent: () => Promise<void>
// property entity related APIs (DB only)
getProperty: (key: string) => Promise<BlockEntity | null>
/**
* insert or update property entity
* @param key
* @param schema
* @param opts
*/
upsertProperty: (
key: string,
schema?: Partial<{
type: 'default' | 'map' | 'keyword' | 'date' | 'checkbox' | string,
cardinality: 'many' | 'one',
hide: boolean
public: boolean
}>,
opts?: {}) => Promise<IEntityID>
// block property related APIs
upsertBlockProperty: (
block: BlockIdentity,
key: string,
@@ -806,7 +826,7 @@ export interface IEditorProxy extends Record<string, any> {
removeBlockProperty: (block: BlockIdentity, key: string) => Promise<void>
getBlockProperty: (block: BlockIdentity, key: string) => Promise<BlockEntity | string| null>
getBlockProperty: (block: BlockIdentity, key: string) => Promise<BlockEntity | string | null>
getBlockProperties: (block: BlockIdentity) => Promise<Record<string, any> | null>