Skip to content

API Reference (v3)

Use this section as the fastest entry point into @azure-net/kit API. Every API page starts with TypeScript-first signatures (input/output), then explains behavior.

Import map

  • @azure-net/kit - core exports (delivery, shared, UI, Svelte helpers)
  • @azure-net/kit/infra - HTTP, query, response, resource, datasource
  • @azure-net/kit/schema - validation rules and validation message packs
  • @azure-net/kit/edges - presenter/store primitives from edges-svelte
  • @azure-net/kit/edges/server - server handle utilities
  • @azure-net/kit/edges/state - state primitives
  • @azure-net/kit/edges/context - request context
  • @azure-net/kit/edges/dev - devtools
  • @azure-net/kit/edges/plugin - plugin integration
  • @azure-net/kit/tools - utilities re-exported from azure-net-tools
  • @azure-net/kit/i18n - translations API re-export

Layer pages

Quick index (methods and classes)

Svelte

  • createAsyncSignal - async request state with runes, refresh, and global key-based refresh
  • refreshAsyncSignal - refresh one signal by key
  • refreshAllAsyncSignals - refresh all registered signals
  • createActiveForm - form state, async submit, schema error mapping
  • createQuery - query state with optional auto-refresh signal binding

Delivery

  • createAsyncHelpers - async action/resource wrappers with retries and parser integration
  • createErrorParser - unified parser for HTTP, schema, and app errors
  • createServerAction - server-only action factory with injected deps
  • createServerActionFactory - pre-injected server action factory
  • schema - schema builder entrypoint
  • createSchemaFactory - schema builder factory with custom rules
  • createRules - rule factory based on selected message set

Infrastructure

  • HttpService - HTTP client wrapper around ky
  • HttpServiceResponse - normalized response wrapper
  • HttpServiceError - normalized error wrapper
  • QueryBuilder - URL query serializer
  • ResponseBuilder - response mapping/extraction pipeline
  • DTOMapper - DTO-to-plain-object mapper base
  • BaseHttpDatasource - base datasource with request helper
  • HttpStatusCode - HTTP status enum

Shared and UI

  • createBoundaryProvider - DI provider with SSR/client caches
  • cleanupProvider - provider cleanup
  • createMiddlewareManager - middleware orchestration for app routing
  • UniversalCookie - universal cookie API
  • ClassMirror - service-to-repository method mirroring
  • createEventBus / EventBus - typed event bus
  • AppEvents - app-level event bus provider
  • event / prevent / stop / once - event modifiers
  • onClickOutside - outside-click action
  • Mask / masked - masking engine and action
  • scrollTo - scrolling helper

Edges, tools, i18n

  • createPresenter, createPresenterFactory, createStore, createStoreFactory, batch, transaction
  • edgesHandle, edgesHandleRaw, __autoWrapHandle
  • createState, createDerivedState, createRawState
  • RequestContext, DevTools, edgesPlugin
  • all exports from @azure-net/kit/tools
  • createTranslations, Path, Translation

Notes

  • This API reference targets package version 3.x.
  • If you migrated from older 0.x/1.x docs, always prefer imports shown on these API pages.