Skip to content

GlofasFloodOptions ​

Import from: @xbbg/xnews

Defined in: src/sources/glofasflood.ts (declaration: sources/glofasflood.d.ts:15)

Extends ​

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.

Inherited from ​

EventFetchOptions.allowCrossOriginRedirects


basins? ​

readonly optional basins?: readonly GlofasBasin[]

Defined in: src/sources/glofasflood.ts (declaration: sources/glofasflood.d.ts:17)

Overrides the default registry while retaining one batched API request.


countryCodes? ​

readonly optional countryCodes?: readonly string[]

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

Restrict to these ISO 3166-1 alpha-2 countries, where the publisher states one.

Inherited from ​

EventFetchOptions.countryCodes


fetch? ​

readonly optional fetch?: SourceFetch

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

Inherited from ​

EventFetchOptions.fetch


limit? ​

readonly optional limit?: number

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

Inherited from ​

EventFetchOptions.limit


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.

Inherited from ​

EventFetchOptions.maxResponseBytes


minSeverity? ​

readonly optional minSeverity?: EventSeverity

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

Drop events below this normalized urgency.

Inherited from ​

EventFetchOptions.minSeverity


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.

Inherited from ​

EventFetchOptions.msrbAcceptTermsOfUse


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".

Inherited from ​

EventFetchOptions.redirect


secUserAgent? ​

readonly optional secUserAgent?: string

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

Inherited from ​

EventFetchOptions.secUserAgent


signal? ​

readonly optional signal?: AbortSignal

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

Inherited from ​

EventFetchOptions.signal


since? ​

readonly optional since?: string | Date

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

Inherited from ​

EventFetchOptions.since


timeoutMs? ​

readonly optional timeoutMs?: number

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

Inherited from ​

EventFetchOptions.timeoutMs


until? ​

readonly optional until?: string | Date

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

Inherited from ​

EventFetchOptions.until


userAgent? ​

readonly optional userAgent?: string

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

Inherited from ​

EventFetchOptions.userAgent

Last updated:

xbbg is independent open-source software and is not affiliated with, endorsed by, sponsored by, or approved by Bloomberg Finance L.P.