Class BaseMangaSourceClient<TMangaEntry, TMangaDetail>`Abstract`

Abstract base class for manga source API clients. Provides common functionality and defines the interface that all manga sources must implement.

Type Parameters

TMangaEntry extends BaseMangaEntry = BaseMangaEntry
TMangaDetail extends BaseMangaDetail = BaseMangaDetail

Hierarchy (View Summary)

BaseMangaSourceClient
- ComickClient
- MangaDexClient

Index

Constructors

constructor

Methods

getSource getConfig searchManga getMangaDetail extractAniListId searchAndGetAniListManga clearCache getCacheStatus

Constructors

constructor

new BaseMangaSourceClient<
    TMangaEntry extends BaseMangaEntry = BaseMangaEntry,
    TMangaDetail extends BaseMangaDetail = BaseMangaDetail,
>(
    config: MangaSourceConfig,
): BaseMangaSourceClient<TMangaEntry, TMangaDetail>
Type Parameters
- TMangaEntry extends BaseMangaEntry = BaseMangaEntry
- TMangaDetail extends BaseMangaDetail = BaseMangaDetail
Parameters
- config: MangaSourceConfig
Returns BaseMangaSourceClient<TMangaEntry, TMangaDetail>
- Defined in src/api/manga-sources/base-client.ts:30

Methods

getSource

getSource(): MangaSource
Get the source identifier for this client.

Returns MangaSource
- Defined in src/api/manga-sources/base-client.ts:38

getConfig

getConfig(): MangaSourceConfig
Get the configuration for this source.

Returns MangaSourceConfig
- Defined in src/api/manga-sources/base-client.ts:45

`Abstract`searchManga

searchManga(query: string, limit?: number): Promise<TMangaEntry[]>
Search for manga using this source's API. Must be implemented by each source.
Parameters
- query: string
- Optionallimit: number
Returns Promise<TMangaEntry[]>
- Defined in src/api/manga-sources/base-client.ts:53

`Abstract`getMangaDetail

getMangaDetail(slug: string): Promise<null | TMangaDetail>
Get detailed information about a specific manga. Must be implemented by each source.
Parameters
- slug: string
Returns Promise<null | TMangaDetail>
- Defined in src/api/manga-sources/base-client.ts:62

extractAniListId

extractAniListId(manga: TMangaEntry): Promise<null | number>
Extract AniList ID from a manga entry by fetching its details.
Parameters
- manga: TMangaEntry
Returns Promise<null | number>
- Defined in src/api/manga-sources/base-client.ts:172

searchAndGetAniListManga

searchAndGetAniListManga(
    query: string,
    accessToken: string,
    limit?: number,
): Promise<EnhancedAniListManga[]>
Search for manga and get their AniList counterparts. This provides the main workflow that all sources can use.
Parameters
- query: string
- accessToken: string
- limit: number = 1
Returns Promise<EnhancedAniListManga[]>
- Defined in src/api/manga-sources/base-client.ts:211

clearCache

clearCache(queries: string[]): number
Clear cache for specific search queries.
Parameters
- queries: string[]
Returns number
- Defined in src/api/manga-sources/base-client.ts:297

getCacheStatus

getCacheStatus(): {
    source: string;
    totalEntries: number;
    activeEntries: number;
    expiredEntries: number;
}
Get cache status for debugging.

Returns {
    source: string;
    totalEntries: number;
    activeEntries: number;
    expiredEntries: number;
}
- Defined in src/api/manga-sources/base-client.ts:319

Class BaseMangaSourceClient<TMangaEntry, TMangaDetail>`Abstract`

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseMangaSourceClient<TMangaEntry, TMangaDetail>

Methods

getSource

Returns MangaSource

getConfig

Returns MangaSourceConfig

`Abstract`searchManga

Parameters

Returns Promise<TMangaEntry[]>

`Abstract`getMangaDetail

Parameters

Returns Promise<null | TMangaDetail>

extractAniListId

Parameters

Returns Promise<null | number>

searchAndGetAniListManga

Parameters

Returns Promise<EnhancedAniListManga[]>

clearCache

Parameters

Returns number

getCacheStatus

Returns {
    source: string;
    totalEntries: number;
    activeEntries: number;
    expiredEntries: number;
}

Settings

On This Page

Class BaseMangaSourceClient<TMangaEntry, TMangaDetail>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseMangaSourceClient<TMangaEntry, TMangaDetail>

Methods

getSource

Returns MangaSource

getConfig

Returns MangaSourceConfig

AbstractsearchManga

Parameters

Returns Promise<TMangaEntry[]>

AbstractgetMangaDetail

Parameters

Returns Promise<null | TMangaDetail>

extractAniListId

Parameters

Returns Promise<null | number>

searchAndGetAniListManga

Parameters

Returns Promise<EnhancedAniListManga[]>

clearCache

Parameters

Returns number

getCacheStatus

Returns { source: string; totalEntries: number; activeEntries: number; expiredEntries: number;}

Settings

On This Page

Class BaseMangaSourceClient<TMangaEntry, TMangaDetail>`Abstract`

`Abstract`searchManga

`Abstract`getMangaDetail

Returns {
source: string;
totalEntries: number;
activeEntries: number;
expiredEntries: number;
}