Skip to content

Commit 2d65160

Browse files
committed
minor: Modify Pokedex config types
1 parent 58026cd commit 2d65160

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

index.d.ts

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2225,27 +2225,29 @@ declare module "pokeapi-js-wrapper" {
22252225

22262226
export class Pokedex {
22272227
constructor(config?: {
2228-
/** The protocol to be used */
2229-
/** @default 'https' */
2228+
/** The protocol to be used
2229+
* @default 'https' */
22302230
protocol?: "https" | "http";
2231-
/** The hostname of the PokeAPI instance */
2232-
/** @default 'pokeapi.co' */
2231+
/** The hostname of the PokeAPI instance
2232+
* @default 'pokeapi.co' */
22332233
hostName?: string;
2234-
/** The version path of the API */
2235-
/** @default '/api/v2/' */
2234+
/** The version path of the API
2235+
* @default '/api/v2/' */
22362236
versionPath?: string;
2237-
/** The offset to be used in list requests */
2238-
/** @default 0 */
2237+
/** The offset to be used in list requests
2238+
* @default 0 */
22392239
offset?: number;
2240-
/** The limit to be used in list requests */
2241-
/** @default 100000 */
2240+
/** The limit to be used in list requests
2241+
* @default 100000 */
22422242
limit?: number;
2243-
/** The timeout of a response in milliseconds */
2244-
/** @default 10 * 1000 // (10 seconds) */
2243+
/** The timeout of a response in milliseconds
2244+
* @default 10 * 1000 // (10 seconds) */
22452245
timeout?: number;
2246-
/** @default true */
2246+
/** Enables browsers to cache all responses when set to `true`
2247+
* @default true */
22472248
cache?: boolean;
2248-
/** @default false */
2249+
/** Enables browsers to cache images when set to `true`. [Learn more](https://github.com/PokeAPI/pokeapi-js-wrapper#caching-images)
2250+
* @default false */
22492251
cacheImages?: boolean;
22502252
});
22512253

0 commit comments

Comments
 (0)