aveniam

library1.3.0jsnpmunverified

A tool for converting Postgres schemas into TypeScript interfaces. Version 1.3.0 is the latest stable release. It generates TypeScript type definitions directly from your database schema, reducing manual type writing and ensuring type safety across your application. Differentiates itself by focusing on PostgreSQL-specific features and integrating with existing database structures. No known release cadence; it appears to be a utility package with infrequent updates.

database

npm install aveniam

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AVENIAM

aveniam

databasejavascriptv1.3.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

aveniam

✓ import aveniam from 'aveniam'

✗ const aveniam = require('aveniam')

Default export; ESM-only since v1.3.0.

SchemaToTypes

✓ import { SchemaToTypes } from 'aveniam'

✗ const { SchemaToTypes } = require('aveniam')

Named export for the main conversion function.

PostgresSchema

✓ import type { PostgresSchema } from 'aveniam'

✗ import { PostgresSchema } from 'aveniam'

TypeScript type export; use 'import type' for type-only imports.

Connects to a Postgres database, fetches schema info, and generates TypeScript interfaces using aveniam.

import aveniam from 'aveniam'; import { Client } from 'pg'; const client = new Client({ connectionString: process.env.DATABASE_URL ?? '' }); await client.connect(); const res = await client.query(`SELECT table_name, column_name, data_type FROM information_schema.columns WHERE table_schema = 'public'`); const schema = res.rows.reduce((acc, row) => { if (!acc[row.table_name]) acc[row.table_name] = []; acc[row.table_name].push({ name: row.column_name, type: row.data_type }); return acc; }, {}); const types = aveniam(schema); console.log(types); await client.end();

Debug

Known issues

gotchaThe package name 'aveniam' is not intuitive; it may be confused with other libraries.

fix

import from 'aveniam' as shown in documentation.

affects: all

gotchaNo README provided; usage details are inferred from package metadata and source code.

fix

Refer to the GitHub repository for any available examples or issues.

affects: >=1.0.0

deprecatedCommonJS require() may not work in future versions.

fix

Use ESM import syntax (import aveniam from 'aveniam').

affects: >=1.3.0

Errors

Common errors & fixes

Cannot find module 'aveniam'

Package not installed or import path incorrect.

fix

Run 'npm install aveniam' and ensure import is 'import aveniam from 'aveniam''.

aveniam is not a function

Incorrect import style (e.g., using require with default export in ESM).

fix

Use ESM import: 'import aveniam from 'aveniam''.

Upgrade

Version history

1.3.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

13 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/AlecBrakus/aveniam ↗

packageaveniam ↗

homepagehttps://github.com/AlecBrakus/aveniam.git ↗