LibgenSearchUrlOptions

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

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

Extends

• LibgenMirrorOptions

Extended by

• LibgenSearchOptions

Properties

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

LibgenMirrorOptions.baseUrl

---

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.

---

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.

---

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

LibgenMirrorOptions.layout

---

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.

---

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.

---

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

---

sortBy?

readonly optional sortBy?: LibgenSortBy

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

---

sortOrder?

readonly optional sortOrder?: LibgenSortOrder

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

---

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"].