Standard Result

A standardized result type for TypeScript with full CommonJS and ES Module support.

Installation

npm install standard-result

Usage

TypeScript / ES Module

import { createResult, type Result, type BaseOptions } from "standard-result";

// Create a success result
const successResult = createResult({
  status: "success",
  data: { userId: 123 },
  message: "User created successfully",
});

// Create an error result
const errorResult = createResult({
  status: "error",
  message: "User not found",
});

CommonJS

const { createResult } = require("standard-result");

const result = createResult({
  status: "success",
  data: { value: 42 },
});

API

Types

• Status: "error" | "success"
• Level: "error" | "success" | "warn" | "info"
• BaseOptions: Configuration object for creating results
• Result<O>: The result type with inferred properties

Functions

createResult<O extends BaseOptions>(options: O): Result<O>

Creates a standardized result object with the following properties:

• status: The status of the result
• level: The severity level (defaults to status if not specified)
• timestamp: ISO timestamp string
• data: Optional data payload
• message: Optional message string

License

MIT