zod-to-camel-case

Convert zod schemas object keys to camel case.

Usage

The zodToCamelCase supports both unidirectional and bidirectional transformation of schemas

$3

By default zodToCamelCase supports unidirectional transformation of the schema.

So the input will be expected to in the original snake-case format. The output data/type will be camel-case.

``ts
import { z } from "zod";
import zodToCamelCase from "zod-to-camel-case";

const userSchemaSnake = z.object({
full_name: z.string(),
user: z.object({
email_addresses: z.array(z.email()),
}),
});
const userSchema = zodToCamelCase(userSchemaSnake);

// Infer the type using zod
type User = z.infer;
// type => { fullName: string, user: { emailAddresses: string[] } }

// This input is snake-case
const results = userSchema.parse({
full_name: "Turanga Leela",
user: {
email_addresses: ["name@example.com"],
},
});

// Assert that the output is camel-case
expect(results).toEqual({
fullName: "Turanga Leela",
user: {
emailAddresses: ["name@example.com"],
},
});
`

$3

By passing {bidirectional: true} as a second option to zodToCamelCase will change the expected input to be camel-case.

`ts
import { z } from "zod";
import zodToCamelCase from "zod-to-camel-case";

const userSchemaSnake = z.object({
full_name: z.string(),
user: z.object({
email_addresses: z.array(z.email()),
}),
});
const userSchema = zodToCamelCase(userSchemaSnake, { bidirectional: true });

// Infer the type using zod
type User = z.infer;
// type => { fullName: string, user: { emailAddresses: string[] } }

// This input is camel-case
// IMPORTANT: The input to parse() & safeParse() is now camel case
const results = userSchema.parse({
fullName: "Turanga Leela",
user: {
emailAddresses: ["name@example.com"],
},
});

// Assert that the output is camel-case
expect(results).toEqual({
fullName: "Turanga Leela",
user: {
emailAddresses: ["name@example.com"],
},
});
`

Test

To run the tests run, in non-watch mode the coverage reports are available at ./coverage/index.html

`bash
npm test
`

Or for watch mode (no coverage reports)

`bash
npm run test:watch
``


License

MIT