@pgsql/enums

@pgsql/enums is a package that provides PostgreSQL AST enums in TypeScript for easier usage and type safety within your projects that interact with PostgreSQL's AST nodes.

Installation

npm install @pgsql/enums

Usage

After installation, you can import the enums directly from the package and use them in your code. This helps in maintaining type safety and ensuring that only valid enum values are used.

import { A_Expr_Kind } from '@pgsql/enums';

// Example usage
const exprKind: A_Expr_Kind = A_Expr_Kind.AEXPR_LIKE;

switch(exprKind) {
    case A_Expr_Kind.AEXPR_IN:
    case A_Expr_Kind.AEXPR_BETWEEN:
    case A_Expr_Kind.AEXPR_BETWEEN_SYM:
    // Add other enum cases as needed
        console.log('Enum value is valid');
        break;
    default:
        throw new Error('Unexpected enum value');
}

In this example, A_Expr_Kind is an enum imported from @pgsql/enums, and exprKind is a variable of type A_Expr_Kind. This setup ensures that exprKind can only hold values that are valid members of the A_Expr_Kind enum, providing compile-time type checking and reducing runtime errors.

Related

• pgsql-parser: The real PostgreSQL parser for Node.js, providing symmetric parsing and deparsing of SQL statements with actual PostgreSQL parser integration.
• pgsql-deparser: A streamlined tool designed for converting PostgreSQL ASTs back into SQL queries, focusing solely on deparser functionality to complement pgsql-parser.
• pgsql-enums: A utility package offering easy access to PostgreSQL enumeration types in JSON format, aiding in string and integer conversions of enums used within ASTs to compliment pgsql-parser
• @pgsql/enums: Provides PostgreSQL AST enums in TypeScript, enhancing type safety and usability in projects interacting with PostgreSQL AST nodes.
• @pgsql/types: Offers TypeScript type definitions for PostgreSQL AST nodes, facilitating type-safe construction, analysis, and manipulation of ASTs.
• @pgsql/utils: A comprehensive utility library for PostgreSQL, offering type-safe AST node creation and enum value conversions, simplifying the construction and manipulation of PostgreSQL ASTs.
• pg-proto-parser: A TypeScript tool that parses PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
• libpg-query: The real PostgreSQL parser exposed for Node.js, used primarily in pgsql-parser for parsing and deparsing SQL queries.

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating Software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the Software code or Software CLI, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.