Class Notes

Hierarchy (View Summary)

Base
- Notes

Index

Constructors

Methods

create delete edit get revert search

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:19

Methods

create

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

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

delete

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

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

edit

edit(id: number, options: EditNoteOptions): Promise<null>
Requires Api Key Auth
Edit Note
Parameters
- id: number
- options: EditNoteOptions
Returns Promise<null>
Operation Id
editNote

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

get

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

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

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
revertNote

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

search

search(options?: SearchNotesOptions): Promise<Note[]>
Search Notes
Parameters
- Optionaloptions: SearchNotesOptions
Returns Promise<Note[]>
Operation Id
searchNotes

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