Class Pr0grammItemsService

Hierarchy

Pr0grammItemsService

Index

Constructors

Properties

Methods

delete getInfo getItems getItemsAround getItemsNewer getItemsOlder rateLimited vote walkStream walkStreamNewer walkStreamOlder parseRawGetItemsOptions

Constructors

constructor

new Pr0grammItemsService(requester): Pr0grammItemsService
Parameters
- requester: APIRequester
Returns Pr0grammItemsService
- Defined in pr0gramm-api.ts:39

Properties

`Private` `Readonly` requester

requester: APIRequester

Methods

delete

delete(options): Promise<Pr0grammResponse>
Parameters
- options: DeleteItemOptions
Returns Promise<Pr0grammResponse>
- Defined in pr0gramm-api.ts:41

getInfo

getInfo(itemId): Promise<GetItemsInfoResponse>
Parameters
- itemId: number
Returns Promise<GetItemsInfoResponse>
- Defined in pr0gramm-api.ts:45

getItems

getItems(options): Promise<GetItemsResponse>
Parameters
- options: GetItemsOptions
Returns Promise<GetItemsResponse>
- Defined in pr0gramm-api.ts:49

getItemsAround

getItemsAround(options): Promise<GetItemsResponse>
Parameters
- options: GetItemsAroundOptions
Returns Promise<GetItemsResponse>
- Defined in pr0gramm-api.ts:64

getItemsNewer

getItemsNewer(options): Promise<GetItemsResponse>
Parameters
- options: GetItemsNewerOptions
Returns Promise<GetItemsResponse>
- Defined in pr0gramm-api.ts:52

getItemsOlder

getItemsOlder(options): Promise<GetItemsResponse>
Parameters
- options: GetItemsOlderOptions
Returns Promise<GetItemsResponse>
- Defined in pr0gramm-api.ts:58

rateLimited

rateLimited(): Promise<Pr0grammResponse>
Returns Promise<Pr0grammResponse>
- Defined in pr0gramm-api.ts:136

vote

vote(id, absoluteVote): Promise<Pr0grammResponse>
Parameters
- id: number
- absoluteVote: Vote
Returns Promise<Pr0grammResponse>
- Defined in pr0gramm-api.ts:130

walkStream

walkStream(start, options, functions): AsyncIterableIterator<Item>
Parameters
- start: number
- options: GetItemsOptions
- functions: WalkStreamFunctions
Returns AsyncIterableIterator<Item>
- Defined in pr0gramm-api.ts:92

walkStreamNewer

walkStreamNewer(options): AsyncIterableIterator<Item>
Parameters
- options: GetItemsNewerOptions
Returns AsyncIterableIterator<Item>
- Defined in pr0gramm-api.ts:71

walkStreamOlder

walkStreamOlder(options): AsyncIterableIterator<Item>
Parameters
- options: GetItemsOlderOptions
Returns AsyncIterableIterator<Item>
- Defined in pr0gramm-api.ts:81

`Static` `Private` parseRawGetItemsOptions

parseRawGetItemsOptions(options): {
    collection: undefined | string;
    flags: ItemFlags;
    likes: undefined | string;
    promoted: number;
    self: number;
    tags: undefined | string;
    user: undefined | string;
}
Parameters
- options: GetItemsOptions
Returns {
    collection: undefined | string;
    flags: ItemFlags;
    likes: undefined | string;
    promoted: number;
    self: number;
    tags: undefined | string;
    user: undefined | string;
}
- collection: undefined | string
- flags: ItemFlags
- likes: undefined | string
- promoted: number
- self: number
- tags: undefined | string
- user: undefined | string
- Defined in pr0gramm-api.ts:117

Class Pr0grammItemsService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

requester: APIRequester

Returns Pr0grammItemsService

Properties

Private Readonly requester

Methods

delete

Parameters

options: DeleteItemOptions

Returns Promise<Pr0grammResponse>

getInfo

Parameters

itemId: number

Returns Promise<GetItemsInfoResponse>

getItems

Parameters

options: GetItemsOptions

Returns Promise<GetItemsResponse>

getItemsAround

Parameters

options: GetItemsAroundOptions

Returns Promise<GetItemsResponse>

getItemsNewer

Parameters

options: GetItemsNewerOptions

Returns Promise<GetItemsResponse>

getItemsOlder

Parameters

options: GetItemsOlderOptions

Returns Promise<GetItemsResponse>

rateLimited

Returns Promise<Pr0grammResponse>

vote

Parameters

id: number

absoluteVote: Vote

Returns Promise<Pr0grammResponse>

walkStream

Parameters

start: number

options: GetItemsOptions

functions: WalkStreamFunctions

Returns AsyncIterableIterator<Item>

walkStreamNewer

Parameters

options: GetItemsNewerOptions

Returns AsyncIterableIterator<Item>

walkStreamOlder

Parameters

options: GetItemsOlderOptions

Returns AsyncIterableIterator<Item>

Static Private parseRawGetItemsOptions

Parameters

options: GetItemsOptions

Returns { collection: undefined | string; flags: ItemFlags; likes: undefined | string; promoted: number; self: number; tags: undefined | string; user: undefined | string; }

collection: undefined | string

flags: ItemFlags

likes: undefined | string

promoted: number

self: number

tags: undefined | string

user: undefined | string

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` requester

`Static` `Private` parseRawGetItemsOptions

Returns {
collection: undefined | string;
flags: ItemFlags;
likes: undefined | string;
promoted: number;
self: number;
tags: undefined | string;
user: undefined | string;
}