Class NoteApi

TODO 可以考虑使用 fields() 方法设置然后产生一个新的 Api 实例

Hierarchy

NoteApi

Index

Constructors

Properties

Methods

create get list remove resourcesById tagsById update

Constructors

constructor

new NoteApi(ajax: Ajax): NoteApi
Parameters
- ajax: Ajax
Returns NoteApi
- Defined in api/NoteApi.ts:20

Properties

`Private` ajax

ajax: Ajax

Methods

create

create(param: RequiredField<Partial<NoteProperties>, "title">): Promise<NoteCreateRes>
Parameters
- param: RequiredField<Partial<NoteProperties>, "title">
Returns Promise<NoteCreateRes>
- Defined in api/NoteApi.ts:39

get

get(id: string): Promise<NoteGetRes & CommonType>
Parameters
- id: string
Returns Promise<NoteGetRes & CommonType>
- Defined in api/NoteApi.ts:30
get<K>(id: string, fields?: K[]): Promise<Pick<NoteProperties, K> & CommonType>
Type Parameters
- K extends keyof NoteProperties = "id" | "title" | "parent_id"
Parameters
- id: string
- Optional fields: K[]
Returns Promise<Pick<NoteProperties, K> & CommonType>
- Defined in api/NoteApi.ts:31

list

list(): Promise<PageRes<NoteGetRes>>
Returns Promise<PageRes<NoteGetRes>>
- Defined in api/NoteApi.ts:22
list<K>(pageParam: PageParam<NoteProperties> & FieldsParam<K>): Promise<PageRes<Pick<NoteProperties, K>>>
Type Parameters
- K extends keyof NoteProperties = "id" | "title" | "parent_id"
Parameters
- pageParam: PageParam<NoteProperties> & FieldsParam<K>
Returns Promise<PageRes<Pick<NoteProperties, K>>>
- Defined in api/NoteApi.ts:23

remove

remove(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in api/NoteApi.ts:48

resourcesById

resourcesById(id: string): Promise<ResourceGetRes[]>
Parameters
- id: string
Returns Promise<ResourceGetRes[]>
- Defined in api/NoteApi.ts:59
resourcesById<K>(id: string, fields: K[]): Promise<(Pick<ResourceProperties, K> & CommonType)[]>
Type Parameters
- K extends keyof ResourceProperties = "id" | "title"
Parameters
- id: string
- fields: K[]
Returns Promise<(Pick<ResourceProperties, K> & CommonType)[]>
- Defined in api/NoteApi.ts:60

tagsById

tagsById(id: string): Promise<TagGetRes[]>
Parameters
- id: string
Returns Promise<TagGetRes[]>
- Defined in api/NoteApi.ts:52

update

update(param: RequiredField<Partial<NoteProperties>, "id">): Promise<NoteUpdateRes>
Parameters
- param: RequiredField<Partial<NoteProperties>, "id">
Returns Promise<NoteUpdateRes>
- Defined in api/NoteApi.ts:43

Generated using TypeDoc