@ovh-api/common

property count

count?: number;

• max number of entry in your cache

property silotClass

silotClass?: SlotConstructor;

• explicite silot construtor used to overwrite in memory default silotCache

property size

size?: number;

• max memmory used to store your cache

property ttl

ttl?: number;

• Time to live in second

property options

options: ICacheOptions;

method discard

discard: (path: string) => Promise<boolean>;

method flush

flush: () => Promise<void>;

method get

get: (path: string) => Promise<any | undefined>;

method store

store: (path: string, value: any, size: number) => Promise<boolean>;

method cache

cache: (template: string, param: ICacheOptions | CacheAction) => Promise<any>;

• cache controle

method doRequest

doRequest: (
    httpMethod: string,
    path: string,
    pathTemplate: string,
    params?: any
) => Promise<any>;

• Execute a request on the API with promise

  Parameter httpMethod

  : The HTTP method GET POST PUT DELETE

  Parameter path

  : The request final path

  Parameter pathTemplate

  : The request path with {pathParams}

  Parameter params

  : The request parameters (passed as query string or body params)