Skip to main content
Home
Browse packagesDocsSign in

@mizu/internal@0.9.2
Built and signed on GitHub Actions

latest
lowlighter/mizu

🦮 Internal components for mizu.js

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
94%
Published
3 months ago (0.9.2)
type alias Directive

A directive implements a custom behaviour for a matching HTML attribute.

For more information, see the mizu.sh documentation.

Type Parameters

Definition extends { Name?: string | RegExp; Cache?: any; Typings?: AttrTypings; Default?: boolean; Prefix?: boolean; } = { Name: string | RegExp; Cache: null; Typings: any; Default: false; Prefix: false; }

Definition

{ readonly name: Definition["Name"] extends RegExp ? RegExp : Definition["Name"] extends string ? string : (string | RegExp); readonly phase: Phase; readonly multiple?: boolean; readonly typings?: Definition["Typings"]; readonly init?: (renderer: Renderer) => Promisable<void>; readonly setup?: (
renderer: Renderer,
element: HTMLElement | Comment,
_: { cache: Definition["Cache"]; context: Context; state: DeepReadonly<State>; },
) => Promisable<void | Partial<{ state: State; execute: boolean; } | false>>; readonly execute?: (
renderer: Renderer,
element: HTMLElement | Comment,
_: { cache: Definition["Cache"]; context: Context; state: DeepReadonly<State>; attributes: Readonly<Attr[]>; },
) => Promisable<void | Partial<{ element: HTMLElement | Comment; context: Context; state: State; final: boolean; }>>; readonly cleanup?: (
renderer: Renderer,
element: HTMLElement | Comment,
_: { cache: Definition["Cache"]; context: Context; state: DeepReadonly<State>; },
) => Promisable<void>; }
& (Definition["Prefix"] extends true ? { readonly prefix: string; } : { })
& (Definition["Name"] extends RegExp ? { readonly prefix: string; } : { })
& (Definition["Default"] extends true ? { readonly default: string; } : { })

New Ticket: 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:@mizu/internal

Import symbol

import { type Directive } from "@mizu/internal/engine";
or

Import directly with a jsr specifier

import { type Directive } from "jsr:@mizu/internal/engine";

Add Package

pnpm i jsr:@mizu/internal
or (using pnpm 10.8 or older)
pnpm dlx jsr add @mizu/internal

Import symbol

import { type Directive } from "@mizu/internal/engine";

Add Package

yarn add jsr:@mizu/internal
or (using Yarn 4.8 or older)
yarn dlx jsr add @mizu/internal

Import symbol

import { type Directive } from "@mizu/internal/engine";

Add Package

vlt install jsr:@mizu/internal

Import symbol

import { type Directive } from "@mizu/internal/engine";

Add Package

npx jsr add @mizu/internal

Import symbol

import { type Directive } from "@mizu/internal/engine";

Add Package

bunx jsr add @mizu/internal

Import symbol

import { type Directive } from "@mizu/internal/engine";