API Reference¶

createCipherLogger(config?)¶

Creates a Cipher Logger instance.

const cipher = createCipherLogger(config);

Parameter: config?: CipherLoggerConfig — see Configuration for every option.

Returns: CipherLogger

Methods¶

For fully typed adapters, prefer the subpath imports (for example cipher-logger/express) instead of the convenience methods.

cipher.logRequest(input: RequestLogInput): RequestLog¶

Logs a single HTTP request and returns the resolved RequestLog. Useful when you're not going through a supported framework adapter, or when you want to log a request from inside a route handler with final, accurate values.

const log = cipher.logRequest({
  method: "POST",
  path: "/orders",
  status: 201,
  duration: 42,
});

RequestLogInput accepts the required fields plus any optional fields you've enabled in fields.

cipher.express() / subpath¶

import { createExpressMiddleware } from "cipher-logger/express";

app.use(createExpressMiddleware(cipher));
// equivalent: app.use(cipher.express());

Records status and duration on res.finish. See the Express guide.

cipher.next() / subpath¶

import { createNextMiddleware, withCipherLogger } from "cipher-logger/next";

See the Next.js guide — including the timing caveat and accurate route-handler wrapping.

Logger¶

The base logging class, independent of HTTP. Use it for anything that isn't a request — startup messages, background jobs, warnings, caught errors.

import { Logger } from "cipher-logger";

const logger = new Logger({ level: "info", prefix: "app" });

logger.info("Server started");
logger.warn("Deprecated API used", { route: "/old" });
logger.error("Unhandled error", { err: "..." });
logger.debug("Debug info");

Constructor¶

new Logger(options?: LoggerOptions)

Methods¶

Each method accepts a message: string and an optional meta: Record<string, unknown> object that's merged into the log output.

TypeScript exports¶

Core types from the main entry:

import type {
  CipherLogger,
  CipherLoggerConfig,
  RequestLog,
  RequestLogInput,
  OptionalRequestField,
  LogLevel,
  LoggerOptions,
} from "cipher-logger";

Framework middleware types from subpaths:

import type { ExpressMiddleware } from "cipher-logger/express";
import type { NextMiddleware, RouteHandler } from "cipher-logger/next";

See Log Schema for the field-by-field breakdown of RequestLog.