Types

@talosjs/types is a types-only package that collects the common type definitions, unions, and interfaces shared across Talos packages. It has no runtime code, so importing from it adds nothing to your bundle. Use it to keep entity shapes, status values, HTTP methods, and paginated results consistent everywhere.

Installation

Add the package with Bun.

bun add @talosjs/types

Usage

Because the package only ships types, you import them with import type and use them to annotate your own values, functions, and entities. Use IBase as the common shape for persisted entities, and StatusType to constrain a record’s lifecycle state to a known set of values.

import type { IBase, StatusType } from "@talosjs/types";

interface Article extends IBase {
  title: string;
  status: StatusType;
}

const article: Article = {
  id: "art_123",
  title: "Hello world",
  status: "draft", // "draft" | "pending" | "active" | "archived" | ...
  isPublic: true,
  createdAt: new Date(),
};

Use FilterResultType<T> to type the response of any paginated list endpoint, and HttpMethodType (backed by the HTTP_METHODS tuple) to constrain request methods.

import type { FilterResultType, HttpMethodType } from "@talosjs/types";

const listArticles = async (): Promise<FilterResultType<Article>> => {
  const resources = await fetchArticles();
  return {
    resources,
    total: 240,
    totalPages: 12,
    page: 1,
    limit: 20,
  };
};

const method: HttpMethodType = "POST"; // "GET" | "POST" | "PUT" | "DELETE" | ...

ScalarType is a handy union for primitive values, useful when typing loosely-structured records like query params or config maps.

import type { ScalarType } from "@talosjs/types";

// boolean | number | bigint | string
const params: Record<string, ScalarType> = {
  page: 1,
  active: true,
  query: "talos",
};

When to pull these in

The point is consistency across a Talos app or package: entity shapes (IBase), lifecycle states (StatusType), and paginated responses (FilterResultType<T>) line up the same way in every service. The package also carries ready-made unions you’d otherwise rewrite, for HTTP methods (HttpMethodType), content encodings (EncodingType), charsets (CharsetType), and primitive scalars (ScalarType). Because there’s no executable code, none of this reaches your bundle. For one-off local types that aren’t shared between packages, just define them inline.

Getting Started

AI

Framework

Command Line

Installation

Usage

When to pull these in

​Installation

​Usage

​When to pull these in

Installation

Usage

When to pull these in