OsfPreprintsOptions

Import from: @xbbg/xnews, @xbbg/xnews/catalog

Defined in: src/sources/osf.urls.ts (declaration: sources/osf.urls.d.ts:13)

Extends

• SourceFetchOptions
• OsfPreprintsUrlOptions

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

---

fetch?

readonly optional fetch?: SourceFetch

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

Inherited from

SourceFetchOptions.fetch

---

limit?

readonly optional limit?: number

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

Inherited from

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

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

---

pageSize?

readonly optional pageSize?: number

Defined in: src/sources/osf.urls.ts (declaration: sources/osf.urls.d.ts:7)

Inherited from

OsfPreprintsUrlOptions.pageSize

---

providers?

readonly optional providers?: readonly string[]

Defined in: src/sources/osf.urls.ts (declaration: sources/osf.urls.d.ts:6)

OSF preprint-provider ids, such as socarxiv and psyarxiv.

Inherited from

OsfPreprintsUrlOptions.providers

---

publishedSince?

readonly optional publishedSince?: string

Defined in: src/sources/osf.urls.ts (declaration: sources/osf.urls.d.ts:10)

Inherited from

OsfPreprintsUrlOptions.publishedSince

---

publishedUntil?

readonly optional publishedUntil?: string

Defined in: src/sources/osf.urls.ts (declaration: sources/osf.urls.d.ts:11)

Inherited from

OsfPreprintsUrlOptions.publishedUntil

---

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

---

sort?

readonly optional sort?: string

Defined in: src/sources/osf.urls.ts (declaration: sources/osf.urls.d.ts:9)

OSF JSON:API sort expression. Defaults to -date_published.

Inherited from

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