https://github.com/tomokimiyauci/composite-key

Composite keys, TC39 proposal-richer-keys of compositeKey implementation
https://github.com/tomokimiyauci/composite-key

composite composite-key gc proposal-richer-keys tc39 weak-map

Last synced: 3 months ago
JSON representation

Composite keys, TC39 proposal-richer-keys of compositeKey implementation

• Host: GitHub
• URL: https://github.com/tomokimiyauci/composite-key
• Owner: TomokiMiyauci
• License: mit
• Created: 2023-06-14T13:03:03.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-06T05:02:40.000Z (6 months ago)
• Last Synced: 2024-10-07T16:07:02.862Z (3 months ago)
• Topics: composite, composite-key, gc, proposal-richer-keys, tc39, weak-map
• Language: TypeScript
• Homepage: https://jsr.io/@miyauci/composite-key
• Size: 36.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# composite-key

[![JSR](https://jsr.io/badges/@miyauci/composite-key)](https://jsr.io/@miyauci/composite-key)

[![codecov](https://codecov.io/gh/TomokiMiyauci/composite-key/graph/badge.svg?token=gLgydtlHEF)](https://codecov.io/gh/TomokiMiyauci/composite-key)

[![GitHub](https://img.shields.io/github/license/TomokiMiyauci/composite-key)](https://github.com/TomokiMiyauci/composite-key/blob/main/LICENSE)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)

Composite keys, TC39

[proposal-richer-keys, compositeKey](https://github.com/tc39/proposal-richer-keys/tree/master/compositeKey)

implementation.

## Table of Contents 

- [Install](#install)

- [Usage](#usage)

  - [compositeKey](#compositekey)

  - [compositeSymbol](#compositesymbol)

  - [Polyfill](#polyfill)

- [API](#api)

- [License](#license)

## Install

deno:

```bash

deno add @miyauci/composite-key

```

node:

```bash

npx jsr add @miyauci/composite-key

```

## Usage

### compositeKey

Return reference consisting of a component. This allows using a `Map`, `Set` and

`WeakMap` to weakly and/or privately associate data with the lifetime of a group

of values.

It requires at least one component must be object that can be placed in a

`WeakMap`.

```ts

import { compositeKey } from "@miyauci/composite-key";

import { assertEquals, assertNotEquals } from "@std/assert";

declare const fn: (a: number, b: number) => number;

assertEquals(compositeKey(fn, 0, 1), compositeKey(fn, 0, 1));

assertNotEquals(compositeKey(fn, 1, 0), compositeKey(fn, 0, 1));

// @ts-expect-error it require one of more object.

compositeKey(0, 1);

```

### compositeSymbol

Return `Symbol` consisting of a component. This allows strongly attaching data

to an object that is associated with a group of values.

```ts

import { compositeSymbol } from "@miyauci/composite-key";

import { assertEquals, assertNotEquals } from "@std/assert";

declare const object: object;

assertEquals(compositeSymbol(0, 1), compositeSymbol(0, 1));

assertEquals(compositeSymbol(0, object), compositeSymbol(0, object));

assertNotEquals(compositeSymbol(0), compositeSymbol(1));

assertNotEquals(compositeSymbol(0, {}), compositeSymbol(0, {}));

```

### Polyfill

Polyfill affects the global object. You must be very careful when using it.

```ts

import "@miyauci/composite-key/polyfill";

import { assert } from "@std/assert";

assert(compositeKey);

assert(compositeSymbol);

```

## API

See [jsr doc](https://jsr.io/@miyauci/composite-key) for all APIs.

## License

Copyright © 2023-present [Tomoki Miyauchi](https://github.com/TomokiMiyauci).

Released under the [MIT](./LICENSE) license