Skip to content

Shared and UI API

Shared

createBoundaryProvider

Import

ts
import { createBoundaryProvider } from '@azure-net/kit';

TypeScript signature

ts
createBoundaryProvider<TServices, TDeps>(
  name: string,
  settings: {
    dependsOn?: TDeps;
    boot?: (services: TServices) => void | Promise<void>;
    register: (context: TDeps) => Record<string, () => unknown | Promise<unknown>>;
  }
): () => TServices

Creates DI provider with per-request SSR cache and browser cache.


cleanupProvider

Import

ts
import { cleanupProvider } from '@azure-net/kit';

TypeScript signature

ts
cleanupProvider(name: string): void

Disposes cached provider instances (calls dispose() when present).


createMiddlewareManager

Import

ts
import { createMiddlewareManager } from '@azure-net/kit';

TypeScript signature

ts
createMiddlewareManager(middlewares: IMiddleware[]): {
  serverMiddleware: (...) => Promise<unknown>;
  clientMiddleware: (...) => Promise<unknown>;
  executeMiddlewares: (...) => Promise<unknown>;
}

Composes routing/application middlewares for server and client execution.


UniversalCookie

Import

ts
import { UniversalCookie } from '@azure-net/kit';

TypeScript signature

ts
UniversalCookie.set<T>(name: string, value: T, options?: CookieOptions): void
UniversalCookie.get<T>(name: string): T | undefined
UniversalCookie.getAll<T>(): Record<string, T>
UniversalCookie.has(name: string): boolean
UniversalCookie.delete(name: string, options?: CookieOptions): void
UniversalCookie.clear(options?: CookieOptions): void

ClassMirror

Import

ts
import { ClassMirror } from '@azure-net/kit';

TypeScript signature

ts
class ClassMirror<TTarget> {
  constructor(target: TTarget);
}

Mirrors target methods into inheriting service classes while preserving typings via declare.


createEventBus and EventBus

Import

ts
import { createEventBus, EventBus } from '@azure-net/kit';

TypeScript signature

ts
createEventBus<TEventMap>(opts?: ...): EventBus<TEventMap>

class EventBus<TEventMap> {
  publish<K extends keyof TEventMap>(eventType: K, payload: TEventMap[K], metadata?: IEventMetadata): Promise<void>;
  publishBatch(events: ...): Promise<void>;
  subscribe<K extends keyof TEventMap>(eventType: K, handler: DomainEventHandler<TEventMap[K]>, options?: ...): IEventSubscription;
  subscribeMany(...): IEventSubscription;
  subscribeAll(...): IEventSubscription;
  use(...): void;
  getHistory(...): IEvent<unknown>[];
  waitForCompletion(): Promise<void>;
  clear(): void;
}

UI

Event modifiers: event, prevent, stop, immediate, once

Import

ts
import { event, prevent, stop, immediate, once } from '@azure-net/kit';

TypeScript signature

ts
event: {
  prevent: <E extends Event>(handler: (e: E) => unknown) => (e: E) => unknown;
  stop: ...;
  immediate: ...;
  once: ...;
}

Composable event helpers for concise DOM/Svelte handlers.


onClickOutside

Import

ts
import { onClickOutside } from '@azure-net/kit';

TypeScript signature

ts
onClickOutside(node: HTMLElement, initiator?: (event: MouseEvent | TouchEvent) => void): {
  update: (next?: typeof initiator) => void;
  destroy: () => void;
}

Svelte action that triggers when click/touch occurs outside node.


Mask and masked

Import

ts
import { Mask, masked } from '@azure-net/kit';

TypeScript signature

ts
Mask.maskIt(value: string, mask: string, masked?: boolean, tokens?: Tokens): string
Mask.dynamicMask(maskIt: typeof Mask.maskIt, masks: string[], tokens?: Tokens): (value: string, masked?: boolean) => string
masked(el: HTMLInputElement, mask?: string | ((v: string, masked?: boolean) => string), tokens?: Tokens): {
  update: (...) => void;
  destroy: () => void;
}

scrollTo

Import

ts
import { scrollTo } from '@azure-net/kit';

TypeScript signature

ts
scrollTo(nodeOrName: Element | string, offset?: number): void

Scroll helper to an element or selector target.