resolver

Package that owns the resolvable exports.


Package	`@vizejs/composable/resolver`
Own the source	`vize lib pull composable:resolver`
Runtime exports	`VIZE_COMPOSABLE_PACKAGE`, `VizeComposableResolver`, `createVizeComposableDeclarations`, `listVizeComposableImports`, `readComposableLockfile`, `vizeComposableImports`
Gzip budget	15360 B

Usage

import { VIZE_COMPOSABLE_PACKAGE, VizeComposableResolver, createVizeComposableDeclarations, listVizeComposableImports, readComposableLockfile, vizeComposableImports } from "@vizejs/composable/resolver";

API

`VIZE_COMPOSABLE_PACKAGE`

Package that owns the resolvable exports.

const VIZE_COMPOSABLE_PACKAGE

`readComposableLockfile`

Read and validate vize-lib.lock.json.

function readComposableLockfile(file: string): VizeComposableLockfile

`listVizeComposableImports`

Every auto-importable export the options allow, with its direct subpath import.

function listVizeComposableImports( options: VizeComposableResolverOptions = {}, ): readonly VizeComposableImport[]

`VizeComposableResolver`

unplugin-auto-import resolver for every @vizejs/composable export. Server/SSR: build-time only; reads the lockfile once in local mode.

function VizeComposableResolver( options: VizeComposableResolverOptions = {}, ): (name: string) => VizeComposableImport | undefined

AutoImport({ resolvers: [VizeComposableResolver()] });
// useToggle() -> import { useToggle } from "@vizejs/composable/use-toggle"

`vizeComposableImports`

unplugin-auto-import imports preset: { "@vizejs/composable/use-toggle": ["useToggle"] }.

function vizeComposableImports( options: VizeComposableResolverOptions = {}, ): Readonly<Record<string, readonly string[]>>

`createVizeComposableDeclarations`

Global declarations for auto-imported composables, for setups without a generator (Nuxt and unplugin-auto-import emit their own).

function createVizeComposableDeclarations( options: VizeComposableResolverOptions = {}, ): string

Types

`VizeComposableLockedItem`

One vize-lib.lock.json item (the fields the resolver reads).

Member	Type	Description
`name`	`string`	Item name, for example `"use-toggle"`.
`kind`	`string`	Item kind, for example `"composable"`.
`dir`	`string`	Project-relative POSIX directory the registry layout was copied into.

`VizeComposableLockfile`

The parts of vize-lib.lock.json the resolver reads.

Member	Type	Description
`lockfileVersion`	`number`	Lockfile schema version.
`items`	`readonly VizeComposableLockedItem[]`	Pulled items.

`VizeComposableResolverOptions`

Options for the @vizejs/composable resolvers.

Member	Type	Description
`include`?	`readonly VizeComposableEntry[]`	Only resolve exports of these entries (for example `"use-toggle"`).
`exclude`?	`readonly VizeComposableEntry[]`	Never resolve exports of these entries.
`names`?	`readonly string[]`	Only resolve these export names (for example to avoid clashing with another library).
`source`?	`"local" \| "package"`	Resolve to the npm package, or to `vize lib pull` copies recorded in the lockfile.
`root`?	`string`	Project root used to locate the lockfile and pulled directories.
`lockfile`?	`string \| VizeComposableLockfile`	Lockfile path (relative to `root`) or an already-parsed lockfile.
`fallback`?	`boolean`	In `local` mode, resolve entries that were not pulled to the package.

`VizeComposableImport`

An import produced by the resolver: import { name } from from.

Member	Type	Description
`name`	`string`	Export name.
`from`	`string`	Module specifier or absolute file path.