Skip to main content
Home
Browse packagesDocsSign in

@classic/context@0.1.2
Built and signed on GitHub Actions

latest
ngasull/classic
Works with
This package works with Node.js, Deno, BunIt is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
•JSR Score100%•
Published7 months ago (0.1.2)

Type-safe dynamic runtime state API

Type-safe dynamic runtime state API.

  1. Declare a key for a specific runtime type
  2. Provide the typed data in an async closure
  3. Retrieve data directly in user modules

Examples

End-to-end declare, provide & use summary

import { Context } from "@classic/context";
import { assert } from "@std/assert";

type User = {
  id: bigint;
  name: string;
};

// Shared code - export this key to provider and consumers
export const $user = Context.for<User>("user");

// Provider code
const john = {
  id: 42n,
  name: "John",
};

$user.provide(john, () => {
  // Consumer code - `user` is correctly typed as `User`
  assert($user.use() === john);
});

Use functions: expect context transparently in custom logic

import { Context } from "@classic/context";
import { assert } from "@std/assert";

type User = {
  id: bigint;
  name: string;
};

export const $user = Context.for<User>("user");
export const getUserId = () => $user.use().id;

// Provider code
$user.provide({ id: 42n, name: "John" }, () => {
  // Looks the same, but only exposes read access
  assert(getUserId() === 42n);
});

Safe or optional context access

import { Context } from "@classic/context";
import { assert, assertThrows } from "@std/assert";

export const $sessionId = Context.for<string>("sessionId");

assertThrows(() => $sessionId.use());
assert($sessionId.get() === undefined);
Built and signed on
GitHub Actions
View transparency log

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@classic/context

Import symbol

import * as context from "@classic/context";
or

Import directly with a jsr specifier

import * as context from "jsr:@classic/context";

Add Package

pnpm i jsr:@classic/context
or (using pnpm 10.8 or older)
pnpm dlx jsr add @classic/context

Import symbol

import * as context from "@classic/context";

Add Package

yarn add jsr:@classic/context
or (using Yarn 4.8 or older)
yarn dlx jsr add @classic/context

Import symbol

import * as context from "@classic/context";

Add Package

vlt install jsr:@classic/context

Import symbol

import * as context from "@classic/context";

Add Package

npx jsr add @classic/context

Import symbol

import * as context from "@classic/context";

Add Package

bunx jsr add @classic/context

Import symbol

import * as context from "@classic/context";