LibgenSearchOptions

Import from: @xbbg/xnews

Defined in: src/sources/libgen.ts (declaration: sources/libgen.d.ts:95)

Extends

• SourceFetchOptions
• LibgenSearchUrlOptions

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

---

baseUrl

readonly baseUrl: string

Defined in: src/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:42)

Absolute origin of the mirror to query, e.g. https://example.org or https://example.org/libgen. Required: there is no default.

Inherited from

LibgenSearchUrlOptions.baseUrl

---

exactMatch?

readonly optional exactMatch?: boolean

Defined in: src/sources/libgen.ts (declaration: sources/libgen.d.ts:98)

Case-sensitive whole-value filtering; defaults to true.

---

extraParams?

readonly optional extraParams?: Readonly<Record<string, string>>

Defined in: src/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:63)

Extra or corrected query parameters, applied last so they win. Use this when a mirror spells a parameter differently than the layouts above.

Inherited from

LibgenSearchUrlOptions.extraParams

---

fetch?

readonly optional fetch?: SourceFetch

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

Inherited from

SourceFetchOptions.fetch

---

filters?

readonly optional filters?: LibgenFilters

Defined in: src/sources/libgen.ts (declaration: sources/libgen.d.ts:96)

---

includeUploadInfo?

readonly optional includeUploadInfo?: boolean

Defined in: src/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:58)

Adds the upload/modification timestamp columns to the result table.

Inherited from

LibgenSearchUrlOptions.includeUploadInfo

---

layout?

readonly optional layout?: LibgenLayout

Defined in: src/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:44)

Request layout the mirror expects; defaults to "index".

Inherited from

LibgenSearchUrlOptions.layout

---

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/sources/libgen.ts (declaration: sources/libgen.d.ts:100)

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/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:52)

1-based result page; defaults to 1.

Inherited from

LibgenSearchUrlOptions.page

---

perPage?

readonly optional perPage?: number

Defined in: src/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:54)

Rows per page, capped at LIBGEN_MAX_PER_PAGE; defaults to 25.

Inherited from

LibgenSearchUrlOptions.perPage

---

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

---

searchField?

readonly optional searchField?: LibgenSearchField

Defined in: src/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:50)

Columns the query matches; defaults to "default".

Inherited from

LibgenSearchUrlOptions.searchField

---

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

---

sortBy?

readonly optional sortBy?: LibgenSortBy

Defined in: src/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:55)

Inherited from

LibgenSearchUrlOptions.sortBy

---

sortOrder?

readonly optional sortOrder?: LibgenSortOrder

Defined in: src/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:56)

Inherited from

LibgenSearchUrlOptions.sortOrder

---

timeoutMs?

readonly optional timeoutMs?: number

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

Inherited from

SourceFetchOptions.timeoutMs

---

topics?

readonly optional topics?: readonly LibgenTopic[]

Defined in: src/sources/libgen.urls.ts (declaration: sources/libgen.urls.d.ts:48)

Catalog partitions to search; defaults to ["libgen"].

Inherited from

LibgenSearchUrlOptions.topics

---

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