Skills
.Work. You
Rest

nim-api-design

Community

Design Nim APIs with strict, usable contracts

Software Engineering#error handling#api design#data modeling#contracts#nim#accessors
Authorplanetis-m
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Nim public APIs often end up with unclear contracts, inconsistent error behavior, and leaky data-model decisions that make callers misuse or require defensive boilerplate.

Core Features & Use Cases

  • Clear contract-first API design: Keeps proc/template contracts strong and consistent without weakening types, then compensating with ad-hoc runtime checks.
  • Coherent data-model choices: Prefers named object types for semantic data and uses tuples only for tiny local values.
  • Strict accessor error behavior: Designs accessors so invalid or missing required data raises ValueError via a shared helper for consistency, while using lent and var overloads appropriately.

Quick Start

Ask an AI to review your Nim API draft and rewrite the procs, objects, and accessors to follow strict contract rules and consistent ValueError behavior.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: nim-api-design
Download link: https://github.com/planetis-m/skills_experiment/archive/main.zip#nim-api-design

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.