WatchNewsOptions

Import from: @xbbg/xnews

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

Extends

• CompanyNewsQuery

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

CompanyNewsQuery.allowCrossOriginRedirects

---

arxivCategories?

readonly optional arxivCategories?: string | readonly string[]

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

Restricts opt-in arXiv results; leaf IDs match exactly, while archives like econ include all subcategories.

Inherited from

CompanyNewsQuery.arxivCategories

---

bioRxivCategories?

readonly optional bioRxivCategories?: readonly string[]

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

Restricts opt-in bioRxiv/medRxiv results to these subject categories.

Inherited from

CompanyNewsQuery.bioRxivCategories

---

bisInstitutions?

readonly optional bisInstitutions?: readonly string[]

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

Restricts opt-in BIS research results to these exact institution names.

Inherited from

CompanyNewsQuery.bisInstitutions

---

cik?

readonly optional cik?: string

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

Inherited from

CompanyNewsQuery.cik

---

companyName?

readonly optional companyName?: string

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

Inherited from

CompanyNewsQuery.companyName

---

crossrefFilters?

readonly optional crossrefFilters?: Readonly<Record<string, string | readonly string[]>>

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

Extra Crossref filter facets merged into opt-in Crossref queries.

Inherited from

CompanyNewsQuery.crossrefFilters

---

fetch?

readonly optional fetch?: SourceFetch

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

Inherited from

CompanyNewsQuery.fetch

---

intervalMs?

readonly optional intervalMs?: number

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

---

limit?

readonly optional limit?: number

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

Inherited from

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

CompanyNewsQuery.maxResponseBytes

---

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

CompanyNewsQuery.msrbAcceptTermsOfUse

---

openAlexApiKey?

readonly optional openAlexApiKey?: string

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

API key required for opt-in OpenAlex Works retrieval.

Inherited from

CompanyNewsQuery.openAlexApiKey

---

osfProviders?

readonly optional osfProviders?: readonly string[]

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

Restricts opt-in OSF results to these preprint providers (e.g. socarxiv).

Inherited from

CompanyNewsQuery.osfProviders

---

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

CompanyNewsQuery.redirect

---

secForms?

readonly optional secForms?: readonly string[]

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

Inherited from

CompanyNewsQuery.secForms

---

secUserAgent?

readonly optional secUserAgent?: string

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

Inherited from

CompanyNewsQuery.secUserAgent

---

seenIds?

readonly optional seenIds?: Iterable<string>

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

---

signal?

readonly optional signal?: AbortSignal

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

Inherited from

CompanyNewsQuery.signal

---

since?

readonly optional since?: string | Date

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

Inherited from

CompanyNewsQuery.since

---

sources?

readonly optional sources?: readonly NewsProvider[]

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

Inherited from

CompanyNewsQuery.sources

---

ssrnNetworks?

readonly optional ssrnNetworks?: readonly (number | "fen" | "arn" | "ern")[]

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

Restricts opt-in SSRN results to these networks; names or numeric binding ids.

Inherited from

CompanyNewsQuery.ssrnNetworks

---

strict?

readonly optional strict?: boolean

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

Inherited from

CompanyNewsQuery.strict

---

ticker

readonly ticker: string

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

Inherited from

CompanyNewsQuery.ticker

---

timeoutMs?

readonly optional timeoutMs?: number

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

Inherited from

CompanyNewsQuery.timeoutMs

---

until?

readonly optional until?: string | Date

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

Inherited from

CompanyNewsQuery.until

---

userAgent?

readonly optional userAgent?: string

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

Inherited from

CompanyNewsQuery.userAgent

---

worldBankDocTypes?

readonly optional worldBankDocTypes?: readonly string[]

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

Restricts opt-in World Bank results to these document types.

Inherited from

CompanyNewsQuery.worldBankDocTypes