Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.51 KB

README.md

File metadata and controls

75 lines (49 loc) · 2.51 KB
Raw
   /     /   ▶ API Toolkit
  / --- /      A comprehensive collection of tools designed by Hiro to simplify common tasks in
 /     /       API development.

NPM Package

The API Toolkit Library is a comprehensive collection of tools designed by Hiro to simplify common tasks in API development. This library provides functionalities for database management, application shutdown handlers, migration helpers, server version management, etc. It aims to streamline the development process and improve code quality by offering convenient and reusable modules.

Installation

You can start by installing the API Toolkit Library using npm:

npm install @hirosystems/api-toolkit

You should also customize the following ENV variables that control how log messages are displayed:

APPLICATION_NAME=your-api-name
LOG_LEVEL=info

Featured tools

Please see each tool's source directory for additional documentation

Postgres

  • Superclass for connection support and SQL transaction management using postgres.js
  • Connection helpers with automatic retry logic, using the standard postgres ENV variables
  • Migration tools for migration apply and rollback using node-pg-migrate
  • Type definitions and conversion helpers for postgres to node type management and viceversa

Shutdown handlers

  • Node.js signal handlers that provide a way to shut down long-running application components gracefully on unhandled exceptions or interrupt signals.

CPU Profiler

  • Fastify server that controls a profiler capable of generating:
    • .cpuprofile files for CPU usage analysis
    • .heapsnapshot files for memory usage analysis

Logger

  • Standardized logger configuration using pino

Server versioning

  • api-toolkit-git-info executable tool to generate API versioning information based on Git branch, tag, and latest commit
  • Helpers to extract version info to display at runtime or on documentation

Fastify

  • API server creation with CORS, Typebox and Pino logging
  • OpenAPI generator plugin with YAML and JSON exports

Helpers

  • Value conversion functions (hex strings, hashes, etc.)
  • Timer tools (stopwatch, waiters, etc.)

License

The API Toolkit Library is released under the Apache 2.0 License. See the LICENSE file for more details.