Referência da API

Referência da API

Tudo o que os pacotes exportam, agrupado pelo uso. O @velozjs/dom e o @velozjs/ssr reexportam a API reativa, então a maioria dos apps importa de um pacote só.

Reatividade

FunçãoDescrição
createSignal(value, options?)[get, set]. options.equals: comparação, ou false para notificar sempre.
createMemo(fn, initial?, options?)Valor derivado em cache; notifica só quando o resultado muda.
createEffect(fn, initial?)Roda agora e sempre que o que leu mudar; recebe o valor devolvido antes.
createRenderEffect(fn, initial?)Mesmo agendamento do createEffect; usado em atualizações do DOM.
batch(fn)Roda fn e aplica os effects uma vez no fim; devolve o resultado de fn.
untrack(fn)Lê signals em fn sem se inscrever.
on(deps, fn, { defer }?)Dependências explícitas (um getter ou um array); fn roda sem rastreamento.
createRoot(fn)Escopo que não é descartado com o pai; fn recebe dispose.
onCleanup(fn)Roda antes de o dono rodar de novo e quando é descartado.
onMount(fn)Roda uma vez depois que o componente é criado, dentro do dono dele.
catchError(fn, handler)Envia ao handler os erros de fn e das computações criadas nela.
createContext(default?) / useContext(ctx)Injeção de dependência pela árvore de donos.
access(value)Chama value se for função (para props MaybeAccessor<T>).
getCurrentOwner() / runWithOwner(owner, fn)Acesso de baixo nível ao ownership.

Assíncrono

FunçãoDescrição
createResource(fetcher, options?)Valor assíncrono; busca uma vez.
createResource(source, fetcher, options?)Busca quando source é definido e sempre que muda.
resource()O valor, ou lança o último erro.
resource.state / .loading / .error / .latestStatus reativo.
{ mutate, refetch }Define o valor localmente; carrega de novo.
options.initialValue / options.nameComeça pronto com um valor; chave estável para o SSR.

Renderização (@velozjs/dom)

ExportDescrição
render(fn, container)Renderiza em container, substituindo o conteúdo; devolve uma função de descarte.
hydrate(fn, container)Liga-se ao HTML do servidor em container; devolve uma função de descarte.
createElement(tag, props, ...children)JSX sem compilador.
Fragment<>…</>
toNodes(value)Converte qualquer coisa renderizável em nós do DOM.
sanitize(html, options?)Sanitizador de HTML por lista de permissões (allowedTags, allowedAttrs).
sanitizeURL(url) / validateAttribute(name, value)As verificações de URL e atributo usadas pelo renderizador.

Componentes

ComponenteProps
Showwhen, fallback?, children (nós ou (value) => nós)
Foreach, fallback?, children: (item, index) => nós
Switch / MatchSwitch: fallback?; Match: when, children
ErrorBoundaryfallback (nós ou (error, reset) => nós), children
Suspensefallback?, children
Portalmount? (padrão document.body), children
Dynamiccomponent (tag ou componente), demais props repassadas

Estilos (@velozjs/css)

ExportDescrição
css`…`Nome de classe com escopo a partir de um bloco CSS.
styled(tag)`…`Componente com estilos; interpolações recebem as props.
Prop css={{…}}Ativada ao importar @velozjs/css.
getSSRStyles()Estilos coletados no servidor (também devolvidos pelo renderToString).

Servidor (@velozjs/ssr)

ExportDescrição
renderToString(fn){ html, css }, síncrono.
renderToStringAsync(fn, options?){ html, css, data, script } depois que os dados carregam.
renderToStream(fn)ReadableStream<Uint8Array> com os estilos primeiro.
serializeData(data)O JSON escapado usado pelo script de dados.
escapeHTML(s) / escapeAttr(s)Funções de escape.

Plugin do Vite

ts
import veloz from 'vite-plugin-veloz';

veloz({ exclude: ['meu-ui-kit'] });

exclude: pacotes cujos imports de @velozjs/dom não devem ser redirecionados no SSR.