Skip to content

CrossrefWorksOptions ​

Import from: @xbbg/xnews

Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:36)

Transport and query options for fetchCrossrefWorks.

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 ​

SourceFetchOptions.allowCrossOriginRedirects


cursor? ​

readonly optional cursor?: string

Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:31)

Inherited from ​

CrossrefWorksUrlOptions.cursor


fetch? ​

readonly optional fetch?: SourceFetch

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

Inherited from ​

SourceFetchOptions.fetch


filters? ​

readonly optional filters?: Readonly<Record<string, CrossrefFilterValue>>

Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:25)

Inherited from ​

CrossrefWorksUrlOptions.filters


limit? ​

readonly optional limit?: number

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

Inherited from ​

SourceFetchOptions.limit


mailto? ​

readonly optional mailto?: string

Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:32)

Inherited from ​

CrossrefWorksUrlOptions.mailto


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


offset? ​

readonly optional offset?: number

Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:30)

Inherited from ​

CrossrefWorksUrlOptions.offset


order? ​

readonly optional order?: "asc" | "desc"

Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:27)

Inherited from ​

CrossrefWorksUrlOptions.order


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


rows? ​

readonly optional rows?: number

Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:29)

Inherited from ​

CrossrefWorksUrlOptions.rows


secUserAgent? ​

readonly optional secUserAgent?: string

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

Inherited from ​

SourceFetchOptions.secUserAgent


select? ​

readonly optional select?: readonly string[]

Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:28)

Inherited from ​

CrossrefWorksUrlOptions.select


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


sort? ​

readonly optional sort?: string

Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:26)

Inherited from ​

CrossrefWorksUrlOptions.sort


timeoutMs? ​

readonly optional timeoutMs?: number

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

Inherited from ​

SourceFetchOptions.timeoutMs


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

Last updated:

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