snake-camel-types v1.0.1

snake-camel-types

Utility type definition convert snake_case🐍 ←→ camelCase🐪

Installation

npm install snake-camel-types --save-dev
or
yarn add -D snake-camel-types

Usage

SnakeToCamelCase(🐍→🐪)

Convert single key from snake_case to camelCase

import { SnakeToCamelCase } from "snake-camel-types"
type CamelUserId = SnakeToCamelCase<'user_id'>
// => 'userId'

SnakeToCamel(🐍→🐪)

Convert snake_case key object to camelCase key object

import { SnakeToCamel } from "snake-camel-types"
type SnakeUser = {
  user_id: string,
  birth_year: number
  is_married: boolean,
}
 
type CamelUser = SnakeToCamel<SnakeUser>
// type CamelUser = {
//   userId: string;
//   birthYear: number;
//   isMarried: boolean;
// }

CamelToSnakeCase(🐪→🐍)

Convert single key from camelCase to snake_case

import { CamelToSnakeCase } from "snake-camel-types"
type SnakeUserId = CamelToSnakeCase<'userId'>
// => 'user_id'

CamelToSnake(🐪→🐍)

import { CamelToSnake } from "snake-camel-types"
type CamelUser = {
  userId: string,
  birthYear: number
  isMarried: boolean,
}
type SnakeUser = CamelToSnake<CamelUser>
// type SnakeUser = {
//   user_id: string;
//   birth_year: number;
//   is_married: boolean;
// }

License

MIT