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?
readonlyoptionalallowCrossOriginRedirects?: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?
readonlyoptionalcursor?:string
Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:31)
Inherited from
CrossrefWorksUrlOptions.cursor
fetch?
readonlyoptionalfetch?:SourceFetch
Defined in: src/types.ts (declaration: types.d.ts:88)
Inherited from
filters?
readonlyoptionalfilters?:Readonly<Record<string,CrossrefFilterValue>>
Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:25)
Inherited from
CrossrefWorksUrlOptions.filters
limit?
readonlyoptionallimit?:number
Defined in: src/types.ts (declaration: types.d.ts:115)
Inherited from
mailto?
readonlyoptionalmailto?:string
Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:32)
Inherited from
CrossrefWorksUrlOptions.mailto
maxResponseBytes?
readonlyoptionalmaxResponseBytes?: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?
readonlyoptionalmsrbAcceptTermsOfUse?: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?
readonlyoptionaloffset?:number
Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:30)
Inherited from
CrossrefWorksUrlOptions.offset
order?
readonlyoptionalorder?:"asc"|"desc"
Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:27)
Inherited from
redirect?
readonlyoptionalredirect?: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
rows?
readonlyoptionalrows?:number
Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:29)
Inherited from
secUserAgent?
readonlyoptionalsecUserAgent?:string
Defined in: src/types.ts (declaration: types.d.ts:107)
Inherited from
SourceFetchOptions.secUserAgent
select?
readonlyoptionalselect?: readonlystring[]
Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:28)
Inherited from
CrossrefWorksUrlOptions.select
signal?
readonlyoptionalsignal?:AbortSignal
Defined in: src/types.ts (declaration: types.d.ts:89)
Inherited from
since?
readonlyoptionalsince?:string|Date
Defined in: src/types.ts (declaration: types.d.ts:116)
Inherited from
sort?
readonlyoptionalsort?:string
Defined in: src/sources/crossref.urls.ts (declaration: sources/crossref.urls.d.ts:26)
Inherited from
timeoutMs?
readonlyoptionaltimeoutMs?:number
Defined in: src/types.ts (declaration: types.d.ts:90)
Inherited from
until?
readonlyoptionaluntil?:string|Date
Defined in: src/types.ts (declaration: types.d.ts:117)
Inherited from
userAgent?
readonlyoptionaluserAgent?:string
Defined in: src/types.ts (declaration: types.d.ts:106)
