Class Pool

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Pool
Base<PoolData>
- Pool

Index

Constructors

Methods

[custom] addPost delete removePost revert toJSON update

Constructors

constructor

new Pool(e621: E621<NoV2Options>, data: Pool): Pool
Parameters
- e621: E621<NoV2Options>
- data: Pool
Returns Pool
Inherited from Base.constructor
- Defined in lib/models/Base.ts:11

Methods

[custom]

"[custom]"(_depth: never, opts: InspectOptions): string
Parameters
- _depth: never
- opts: InspectOptions
Returns string
Inherited from Base.[custom]
- Defined in lib/models/Base.ts:19

addPost

addPost(post_id: number): Promise<Pool>
Requires Api Key Auth
Parameters
- post_id: number
Returns Promise<Pool>

Operation Id
pool_elements#create

See
Documentation for more details.
- Defined in lib/models/Pool.ts:27

delete

delete(): Promise<null>
Requires Api Key Auth
You must be Staff+.

Returns Promise<null>

Operation Id
pools#destroy

See
Documentation for more details.
- Defined in lib/models/Pool.ts:42

removePost

removePost(post_id: number): Promise<null>
Requires Api Key Auth
Parameters
- post_id: number
Returns Promise<null>

Operation Id
pool_elements#destroy

See
Documentation for more details.
- Defined in lib/models/Pool.ts:55

revert

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

Operation Id
pools#revert

See
Documentation for more details.
- Defined in lib/models/Pool.ts:68

toJSON

toJSON(): Pool
Returns Pool
Inherited from Base.toJSON
- Defined in lib/models/Base.ts:41

update

update(options: UpdatePoolOptions): Promise<null>
Requires Api Key Auth
Parameters
- options: UpdatePoolOptions
Returns Promise<null>

Operation Id
pools#update

See
Documentation for more details.
- Defined in lib/models/Pool.ts:81