Class VideoReportRequest

Hierarchy (View Summary)

PagedRequest<VideoReportEntry>
- VideoReportRequest

Index

Properties

current

current: number

done

done: boolean

options

options: Required<
    {
        endDate: Date;
        incrementDays: number;
        maxResults?: number;
        onError?: (err: Error | ScrollError) => void;
        onProgress?: (
            items: VideoReportEntry[],
            current: number,
            total?: number,
        ) => void;
        onScrollError?: (err: ScrollError) => void;
        signal?: AbortSignal;
        sortDirection: SortDirection;
        startDate: Date;
        videoIds: undefined | string;
    },
>

total

total: undefined | number

Accessors

endDate

get endDate(): Date
Returns Date
- Defined in src/api/video-report-request.ts:147
set endDate(value: Date): void
Parameters
- value: Date
Returns void
- Defined in src/api/video-report-request.ts:148

startDate

get startDate(): Date
Returns Date
- Defined in src/api/video-report-request.ts:145
set startDate(value: Date): void
Parameters
- value: Date
Returns void
- Defined in src/api/video-report-request.ts:146

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<VideoReportEntry, void>
Supports iterating through results using for await...

Returns AsyncGenerator<VideoReportEntry, void>
See
MDN Docs
Inherited from PagedRequest.[asyncIterator]
- Defined in src/utils/paged-request.ts:174

exec

exec(): Promise<VideoReportEntry[]>
Go through all pages of results and return as an array. TIP: Use the {maxResults} option to limit the maximum number of results

Returns Promise<VideoReportEntry[]>
Inherited from PagedRequest.exec
- Defined in src/utils/paged-request.ts:162

nextPage(): Promise<SearchPage<VideoReportEntry>>
Get the next page of results from API

Returns Promise<SearchPage<VideoReportEntry>>
Inherited from PagedRequest.nextPage
- Defined in src/utils/paged-request.ts:53

Class VideoReportRequest

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

current

done

options

total

Accessors

endDate

Returns Date

Parameters

Returns void

startDate

Returns Date

Parameters

Returns void

Methods

[asyncIterator]

Returns AsyncGenerator<VideoReportEntry, void>

See

exec

Returns Promise<VideoReportEntry[]>

nextPage

Returns Promise<SearchPage<VideoReportEntry>>

Settings

On This Page