WorksQuery

Import from: @xbbg/xnews

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

One catalog query. At least one of the query fields must be set; sources reject an empty query with a config error rather than dialing a catalog with no terms. limit caps returned records and maxPages caps how many result pages a paginating source walks to reach that limit.

Extends

• SourceFetchOptions

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

SourceFetchOptions.allowCrossOriginRedirects

---

author?

readonly optional author?: string

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

---

doi?

readonly optional doi?: string

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

---

fetch?

readonly optional fetch?: SourceFetch

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

Inherited from

SourceFetchOptions.fetch

---

isbn?

readonly optional isbn?: string

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

---

limit?

readonly optional limit?: number

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

Inherited from

SourceFetchOptions.limit

---

maxPages?

readonly optional maxPages?: number

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

Max result pages to walk; defaults to 1.

---

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

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

SourceFetchOptions.msrbAcceptTermsOfUse

---

page?

readonly optional page?: number

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

First result page to read, 1-based; defaults to 1.

---

query?

readonly optional query?: string

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

Free-text query across whatever fields the catalog searches.

---

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

SourceFetchOptions.redirect

---

secUserAgent?

readonly optional secUserAgent?: string

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

Inherited from

SourceFetchOptions.secUserAgent

---

signal?

readonly optional signal?: AbortSignal

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

Inherited from

SourceFetchOptions.signal

---

since?

readonly optional since?: string | Date

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

Inherited from

SourceFetchOptions.since

---

timeoutMs?

readonly optional timeoutMs?: number

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

Inherited from

SourceFetchOptions.timeoutMs

---

title?

readonly optional title?: string

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

---

until?

readonly optional until?: string | Date

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

Inherited from

SourceFetchOptions.until

---

userAgent?

readonly optional userAgent?: string

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

Inherited from

SourceFetchOptions.userAgent