Getting Started

Install

The package ships ESM, CommonJS, and TypeScript declarations. No configuration needed — import and go.

Create a client

createClient(options)

Instantiate a client once per process. Pass optional configuration for timeout, retry behaviour, and a custom fetch implementation.

Parameters

timeoutMs

number

optional

Per-request timeout. Throws LinxioTimeoutError when exceeded.

Default: 30000

retry

{ retries?: number; delayMs?: number }

optional

Retry policy for transient failures on idempotent requests.

Authenticate

POST

Authenticate

/loginlinxio.auth.login(payload)

Login stores the session in memory. Subsequent service calls include the bearer token automatically. Store the session yourself if your process needs to survive restarts.

const login = await linxio.auth.login({
  email: process.env.LINXIO_EMAIL!,
  password: process.env.LINXIO_PASSWORD!,
});

if (login.error) {
  throw login.error;
}

// Persist tokens across restarts
const session = linxio.session();
await saveSession(session);

// Restore on next startup
const linxio2 = createClient(await loadSession());

Read vehicles

linxio.vehicles.list(params)

Paginated list with field projection. Use iterate() to auto-page everything into one array, or stream() for lazy async iteration.

Single page

const { data: vehicles, error, meta } = await linxio.vehicles.list({
  fields: ["id", "regNo", "lastLoggedAt"],
  limit: 100,
  page: 1,
  sort: "regNo",
});

if (error) throw error;
console.log(meta.total, vehicles);

All pages at once

const { data: all, error } = await linxio.vehicles.iterate({
  fields: ["id", "regNo", "lastLoggedAt"],
  limit: 100,
});

if (error) throw error;
for (const v of all) console.log(v.id, v.regNo);

Lazy stream

for await (const vehicle of linxio.vehicles.stream({ limit: 100 })) {
  console.log(vehicle.id, vehicle.regNo);
}

Need full method signatures and return shapes? See the SDK Reference and API Reference.

Getting Started

Install

Create a client

Parameters

Authenticate

Authenticate

Read vehicles

Read vehicles

On this page