@jeftelabs/types
v1.0.0
Published
A collection of types-only helpers used across all the ArapucaJS, Teko, VineJS, and T8ngs packages
Readme
@jeftelabs/types
Helpers de tipos TypeScript para aplicações e bibliotecas do ecossistema JefteLabs.
O pacote reúne tipos reutilizáveis para manipular estruturas, construtores, imports lazy e identificadores de rota. Os helpers são resolvidos pelo TypeScript durante a compilação; não formam uma API de funções de runtime.
Instalação
npm install @jeftelabs/typesUso
Importe os tipos diretamente do entry point do pacote:
import type { DeepPartial, InferRouteParams, Opaque } from '@jeftelabs/types'
type RouteParams = InferRouteParams<'/users/:id/:tab?'>
// { id: string; tab?: string }
type UserId = Opaque<string, 'user-id'>
type ConfigPatch = DeepPartial<{
http: { enabled: boolean; port: number }
}>Helpers disponíveis
Estruturas e propriedades
Prettify<T>normaliza visualmente um tipo mapeando suas propriedades.Primitivereúnenull,undefined, string, number, boolean, symbol e bigint.OneOrMore<T>aceitaTouT[].DeepPartial<T>torna propriedades aninhadas opcionais recursivamente para tipos de objeto.AreAllOptional<T>verifica se as propriedades de topo aceitamundefined/são opcionais conforme a implementação.ExtractUndefined<T>eExtractDefined<T>selecionam chaves pelo pertencimento ou não aundefined.ExtractFunctions<T, IgnoreList>seleciona propriedades que são funções e permite excluir chaves.AsyncOrSync<T>aceitaTouPromiseLike<T>.
Classes e imports
Constructor<T, Arguments>representa um construtor concreto.AbstractConstructor<T, Arguments>representa um construtor abstrato.NormalizeConstructor<T>adapta uma assinatura de construtor para o padrão requerido por mixins TypeScript.LazyImport<DefaultExport>representa função que resolve módulo com export default.UnWrapLazyImport<Fn>extrai o tipo do default export da função lazy.
Tipos opacos
Opaque<T, K>adiciona uma marca nominal usando umunique symbolinterno para distinguir valores estruturalmente iguais.UnwrapOpaque<T>extrai o tipo subjacente de umOpaque.
Parâmetros de rota
InferRouteParams<Identifier>infere parâmetros:name, opcionais:name?, parâmetros com extensão como:file.jsone wildcard*do padrão reconhecido pelo tipo.- Os tipos intermediários
Param,ParamSegment,OptionalParam,OptionalParamSegment,WildcardParameWildcardParamSegmenttambém são exportados porsrc/route.ts.
Os detalhes de inferência e limites estão na referência da API; exemplos de uso estão nos guias.
Documentação
A documentação completa inclui guias, referências, planejamento, testes e benchmarks. As regras para agentes, incluindo a obrigação de documentar toda mudança, estão em AGENTS.md.
Desenvolvimento
npm install
npm run quick:test
npm run lint
npm run typecheck
npm run buildO guia de desenvolvimento descreve os scripts e o fluxo de contribuição. npm test inclui lint e cobertura; npm run format escreve as alterações de formatação.
Licença
MIT. Consulte LICENSE.
