SourceFetchOptions

Import from: @xbbg/xnews

Defined in: src/types.ts (declaration: types.d.ts:87)

Extended by

• DataFetchOptions
• DataReleaseWatcherOptions
• EventFetchOptions
• NewsFeedOptions
• ResolveWorkIdentityOptions
• WorksQuery
• DownloadOptions
• OcrOptions
• AlphaVantageTranscriptOptions
• AnnasArchiveSearchOptions
• ArxivAnnouncementOptions
• ArxivSearchOptions
• BioRxivPapersOptions
• BisResearchHubOptions
• CotFetchOptions
• CrossrefWorksOptions
• EuropePmcSearchOptions
• EarningsTranscriptQueryOptions
• MsrbEmmaFetchOptions
• OpenAlexWorksOptions
• OsfPreprintsOptions
• LibgenSearchOptions
• YahooChartFetchOptions
• YoutubeFeedOptions
• YoutubeTranscriptOptions
• HmdaDataSourceOptions
• WikipediaCongressEditsOptions
• WorldBankIndicatorDataSourceOptions
• UsaSpendingFetchOptions
• GrantsGovFetchOptions
• CdcWastewaterFetchOptions
• UnhcrFetchOptions
• DroughtMonitorFetchOptions
• CaisoFuelMixFetchOptions

Properties

allowCrossOriginRedirects?

readonly optional allowCrossOriginRedirects?: boolean

Defined in: src/types.ts (declaration: types.d.ts:105)

Allows a redirect to leave the requested origin even when a caller User-Agent, sensitive query parameter, request body, or extra header would otherwise refuse it. File downloads need this: catalogs mint a short-lived token on their own host and redirect to a CDN. A redirect into a private network address is still refused.

---

fetch?

readonly optional fetch?: SourceFetch

Defined in: src/types.ts (declaration: types.d.ts:88)

---

limit?

readonly optional limit?: number

Defined in: src/types.ts (declaration: types.d.ts:115)

---

maxResponseBytes?

readonly optional maxResponseBytes?: number

Defined in: src/types.ts (declaration: types.d.ts:92)

Maximum response body size in bytes; defaults to 32 MiB.

---

msrbAcceptTermsOfUse?

readonly optional msrbAcceptTermsOfUse?: boolean

Defined in: src/types.ts (declaration: types.d.ts:114)

MSRB EMMA gates data behind a Terms-of-Use acceptance cookie. Accepting those terms (https://emma.msrb.org) is the caller's act: without this flag, EMMA requests fail closed with a config error instead of the library accepting on the caller's behalf.

---

redirect?

readonly optional redirect?: RequestRedirect

Defined in: src/types.ts (declaration: types.d.ts:97)

Redirect semantics enforced by xnews. "follow" (default) revalidates policy on at most ten hops; the injected fetch receives "manual".

---

secUserAgent?

readonly optional secUserAgent?: string

Defined in: src/types.ts (declaration: types.d.ts:107)

---

signal?

readonly optional signal?: AbortSignal

Defined in: src/types.ts (declaration: types.d.ts:89)

---

since?

readonly optional since?: string | Date

Defined in: src/types.ts (declaration: types.d.ts:116)

---

timeoutMs?

readonly optional timeoutMs?: number

Defined in: src/types.ts (declaration: types.d.ts:90)

---

until?

readonly optional until?: string | Date

Defined in: src/types.ts (declaration: types.d.ts:117)

---

userAgent?

readonly optional userAgent?: string

Defined in: src/types.ts (declaration: types.d.ts:106)