comic-vine-sdk
Version:
A JS/TS client for the Comic Vine API
45 lines (44 loc) • 1.96 kB
TypeScript
import { userOptions } from './options/index.js';
import { ResourceFactory } from './resources/index.js';
import * as resources from './resources/resource-list.js';
type ResourceInstance = ReturnType<ResourceFactory['create']>;
type ResourcePropertyMap = {
[K in keyof typeof resources as Uncapitalize<K>]: InstanceType<(typeof resources)[K]>;
};
export declare class ComicVine implements ResourcePropertyMap {
private resourceFactory;
private resourceCache;
private resourceNames;
readonly character: ResourcePropertyMap['character'];
readonly concept: ResourcePropertyMap['concept'];
readonly episode: ResourcePropertyMap['episode'];
readonly issue: ResourcePropertyMap['issue'];
readonly location: ResourcePropertyMap['location'];
readonly movie: ResourcePropertyMap['movie'];
readonly origin: ResourcePropertyMap['origin'];
readonly person: ResourcePropertyMap['person'];
readonly power: ResourcePropertyMap['power'];
readonly promo: ResourcePropertyMap['promo'];
readonly publisher: ResourcePropertyMap['publisher'];
readonly series: ResourcePropertyMap['series'];
readonly storyArc: ResourcePropertyMap['storyArc'];
readonly team: ResourcePropertyMap['team'];
readonly thing: ResourcePropertyMap['thing'];
readonly video: ResourcePropertyMap['video'];
readonly videoCategory: ResourcePropertyMap['videoCategory'];
readonly videoType: ResourcePropertyMap['videoType'];
readonly volume: ResourcePropertyMap['volume'];
constructor(key: string, options?: userOptions);
private isResourceProperty;
private getResource;
getAvailableResources(): string[];
hasResource(resourceName: string): boolean;
getResourceByName(resourceName: string): ResourceInstance | undefined;
isResourceLoaded(resourceName: string): boolean;
getCacheStats(): {
total: number;
loaded: number;
loadedResources: string[];
};
}
export {};