@cspell/strong-weak-map
TypeScript icon, indicating that this package has built-in type declarations

8.8.3 • Public • Published

@cspell/strong-weak-map

A Map with weakly referenced values.

JavaScript WeakMap provides weak keys and strong values.

StrongWeakMap allows for strong keys and weak values while providing the same API as Map.

Install

npm install -S @cspell/strong-weak-map

Usage

TypeScript Example: Simple text file reader.

import { StrongWeakMap } from '@cspell/strong-weak-map';
import { promises as fs } from 'fs';

const cache = new StrongWeakMap<string, Promise<string>>();

export function readTextFile(filename: string, encoding: BufferEncoding = 'utf8'): Promise<string> {
  const cached = cache.get(filename);
  if (cached) return cached;

  const content = fs.readFile(filename, encoding);

  cache.set(filename, content);

  return content;
}

The above example will reuse the promise as long as it has not been cleaned up by the Garbage Collector.

API

See: Map



Brought to you byStreet Side Software Logo Street Side Software

/@cspell/strong-weak-map/

    Package Sidebar

    Install

    npm i @cspell/strong-weak-map

    Weekly Downloads

    401,838

    Version

    8.8.3

    License

    MIT

    Unpacked Size

    10.7 kB

    Total Files

    7

    Last publish

    Collaborators

    • jason-dent