ferc-elibrary-api / DocketSearch

Class: DocketSearch

Extends

• Search<DocketSearchParams, DocketSearchResults>

Constructors

new DocketSearch()

new DocketSearch(params): DocketSearch

Parameters

Parameter	Type
params	Partial<DocketSearchParams>

Returns

DocketSearch

Overrides

Search<DocketSearchParams, DocketSearchResults>.constructor

Source

search/docket.ts:20

Properties

data

data: undefined | DocketSearchResults

Inherited from

Search.data

Source

search/search.ts:8

---

defaultParams

readonly defaultParams: DocketSearchParams = defaultSearch

Overrides

Search.defaultParams

Source

search/docket.ts:17

---

fetch()

readonly fetch: (params) => Promise<DocketSearchResults>

Parameters

Parameter	Type
params	DocketSearchParams

Returns

Promise<DocketSearchResults>

Overrides

Search.fetch

Source

search/docket.ts:18

---

params

params: DocketSearchParams

Inherited from

Search.params

Source

search/search.ts:5

Methods

getData()

getData(): Promise<void>

Returns

Promise<void>

Source

search/docket.ts:25

---

nextPage()

nextPage(): Promise<boolean>

Returns

Promise<boolean>

Source

search/docket.ts:33

---

prevPage()

prevPage(): Promise<boolean>

Returns

Promise<boolean>

Source

search/docket.ts:43

---

updateParams()

updateParams(params): void

Parameters

Parameter	Type
params	Partial<DocketSearchParams>

Returns

void

Source

search/docket.ts:29