Class Notes

Hierarchy (View Summary)

Base
- Notes

Index

Constructors

Methods

create delete get revert search update

Constructors

constructor

new Notes(e621: E621, client: Client): Notes
Parameters
- e621: E621
- client: Client
Returns Notes
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:20

Methods

create

create(options: CreateNoteOptions): Promise<Note>
Requires Api Key Auth
Create Note
Parameters
- options: CreateNoteOptions
Returns Promise<Note>

Operation Id
notes#create

See
Documentation for more details.
- Defined in lib/modules/Notes.ts:35

delete

delete(id: number): Promise<null>
Requires Api Key Auth
Delete Note
Parameters
- id: number
Returns Promise<null>

Operation Id
notes#destroy

See
Documentation for more details.
- Defined in lib/modules/Notes.ts:52

get

get(id: number): Promise<Note | null>
Get Note
Parameters
- id: number
Returns Promise<Note | null>

Operation Id
notes#show

See
Documentation for more details.
- Defined in lib/modules/Notes.ts:67

revert

revert(id: number, version_id: number): Promise<null>
Requires Api Key Auth
Revert Note
Parameters
- id: number
- version_id: number
Returns Promise<null>

Operation Id
notes#revert

See
Documentation for more details.
- Defined in lib/modules/Notes.ts:84

search

search(options?: SearchNotesOptions): Promise<Note[]>
Notes Index
Parameters
- Optionaloptions: SearchNotesOptions
Returns Promise<Note[]>

Operation Id
notes#index

See
Documentation for more details.
- Defined in lib/modules/Notes.ts:100

update

update(id: number, options: UpdateNoteOptions): Promise<null>
Requires Api Key Auth
Update Note
Parameters
- id: number
- options: UpdateNoteOptions
Returns Promise<null>

Operation Id
notes#update

See
Documentation for more details.
- Defined in lib/modules/Notes.ts:117