@types/hapi__catbox-memory NPM

Installation

npm install --save @types/hapi__catbox-memory

Summary

This package contains type definitions for @hapi/catbox-memory (https://github.com/hapijs/catbox-memory#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hapi__catbox-memory.

index.d.ts

// Type definitions for @hapi/catbox-memory 4.1
// Project: https://github.com/hapijs/catbox-memory#readme
// Definitions by: Simon Schick <https://github.com/SimonSchick>
//                 Silas Rech <https://github.com/lenovouser>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8

import { ClientApi, ClientOptions } from '@hapi/catbox';

interface CatboxMemory<T> extends ClientApi<T> {}

// tslint:disable-next-line:no-unnecessary-class
declare class CatboxMemory<T> implements ClientApi<T> {
    constructor(options?: CatboxMemory.Options);
}

declare namespace CatboxMemory {
    interface Options extends ClientOptions {
        /**
         * Sets an upper limit on the number of bytes that can be stored in the cache.
         * Once this limit is reached no additional items will be added to the cache until some expire.
         * The utilized memory calculation is a rough approximation and must not be relied on.
         * @default 104857600 (100MB).
         */
        maxByteSize?: number | undefined;
        /**
         * The minimum number of milliseconds in between each cache cleanup.
         * @default 1000 (1 second)
         */
        minCleanupIntervalMsec?: number | undefined;
        /**
         * by default, all data is cached as JSON strings, and converted to an object using JSON.parse() on retrieval.
         * By setting this option to true, Buffer data can be stored alongside the stringified data.
         * Buffers are not stringified, and are copied before storage to prevent the value from changing while in the cache.
         * @default false
         */
        allowMixedContent?: boolean | undefined;
        /**
         * by default, buffers stored in the cache with allowMixedContent set to true are copied when they are set but not when they are retrieved.
         * This means a change to the buffer returned by a get() will change the value in the cache. To prevent this,
         * set cloneBuffersOnGet to true to always return a copy of the cached buffer.
         * @default false
         */
        cloneBuffersOnGet?: boolean | undefined;
    }
}

export = CatboxMemory;