Allowing specification of enum values as a list of strings or numbers

Oct 13, 2025 by talynt.org 50 views

Description

The current Schemas package does not support enum types, which limits the ability to define and validate data against a predefined set of values. This is a significant limitation, as enum types are a fundamental concept in data modeling and validation.

Proposed Solution

To address this limitation, we propose implementing enum support in the Schemas package. This could involve the following key components:

Adding a new enum schema type: This would allow developers to define a new schema type that represents a fixed set of values.
Allowing specification of enum values as a list of strings or numbers: This would enable developers to specify the allowed values for the enum type, either as a list of strings or numbers.
Providing validation to ensure that values conform to the defined enum: This would ensure that any values passed to the enum type are valid and conform to the predefined set of values.

Example Usage

Here's an example of how the enum support could be used in a real-world scenario:

import * as p from '@palmares/schemas';

const envSchema = p.object({
   NODE_ENV: p.enum(['dev', 'prod', 'test']).default('dev'),
})

const { parsed: env } = envSchema.parse(process.env)

export { env }

In this example, we define an enum type NODE_ENV that can take on one of three values: dev, prod, or test. We also specify a default value of dev in case the NODE_ENV environment variable is not set.

Benefits

The addition of enum support to the Schemas package would bring several benefits, including:

Improved data validation: By defining a fixed set of allowed values, developers can ensure that their data is valid and consistent.
Increased type safety: Enum types provide a clear and explicit way to define the possible values for a given field, reducing the risk of type-related errors.

Additional Context

Enum types are a fundamental concept in data modeling and validation, and are commonly used to represent data with a fixed set of possible values, such as:

User roles: Enum types can be used to define a set of allowed user roles, such as admin, moderator, or user.
Status codes: Enum types can be used to define a set of allowed status codes, such as success, error, or pending.
Product categories: Enum types can be used to define a set of allowed product categories, such as electronics, clothing, or home goods.

By adding enum support to the Schemas package, developers can more easily define and validate data against a predefined set of values, leading to improved data quality and reduced errors.

Implementation Details

To implement enum support, we would need to add a new enum schema type to the Schemas package. This would involve the following steps:

Define the enum schema type: We would need to define a new schema type that represents a fixed set of values.
Implement validation: We would need to implement validation logic to ensure that values passed to the enum type are valid and conform to the predefined set of values.
Add support for specifying enum values: We would need to add support for specifying the allowed values for the enum type, either as a list of strings or numbers.

Conclusion

Frequently Asked Questions

We've received several questions about the proposed enum support in the Schemas package. Below, we've answered some of the most frequently asked questions to help clarify the benefits and implementation details of this feature.

Q: What is an enum type, and why is it important?

A: An enum type is a data type that represents a fixed set of values. Enum types are important because they provide a clear and explicit way to define the possible values for a given field, reducing the risk of type-related errors and improving data quality.

Q: How will enum support be implemented in the Schemas package?

A: To implement enum support, we will add a new enum schema type to the Schemas package. This will involve defining the enum schema type, implementing validation logic to ensure that values passed to the enum type are valid, and adding support for specifying the allowed values for the enum type.

Q: What are the benefits of enum support in the Schemas package?

A: The benefits of enum support in the Schemas package include improved data validation and increased type safety. By defining a fixed set of allowed values, developers can ensure that their data is valid and consistent, reducing the risk of errors and improving overall data quality.

Q: How will enum support affect existing code that uses the Schemas package?

A: Enum support will not affect existing code that uses the Schemas package. The new enum schema type will be a new addition to the package, and developers will be able to use it in their code without affecting existing functionality.

Q: Can I specify enum values as a list of strings or numbers?

A: Yes, you will be able to specify enum values as a list of strings or numbers. This will provide flexibility in defining the allowed values for the enum type.

Q: How will validation work for enum types?

A: Validation for enum types will ensure that values passed to the enum type are valid and conform to the predefined set of values. This will be implemented through a combination of type checking and value validation.

Q: Can I use enum types with other schema types?

A: Yes, you will be able to use enum types with other schema types. This will provide a flexible way to define complex data structures and ensure that they are valid and consistent.

Q: What are some examples of use cases for enum types?

A: Some examples of use cases for enum types include:

User roles: Enum types can be used to define a set of allowed user roles, such as admin, moderator, or user.
Status codes: Enum types can be used to define a set of allowed status codes, such as success, error, or pending.
Product categories: Enum types can be used to define a set of allowed product categories, such as electronics, clothing, or home goods.

Q: How can I provide feedback on the proposed enum support in the Schemas package?

A: We welcome feedback on the proposed enum support in the Schemas package. You can provide feedback through our issue tracker or by reaching out to us directly.

Q: What is the timeline for implementing enum support in the Schemas package?

A: We are currently working on implementing enum support in the Schemas package. We will provide updates on the timeline and progress through our issue tracker and blog.

Q: Will enum support be backward compatible with existing code?

A: Yes, enum support will be backward compatible with existing code. The new enum schema type will be a new addition to the package, and developers will be able to use it in their code without affecting existing functionality.

Q: Can I use enum types with other libraries or frameworks?

A: Yes, you will be able to use enum types with other libraries or frameworks. The enum schema type will be a standard part of the Schemas package, and developers will be able to use it in their code without affecting existing functionality.

Q: How will enum support affect the performance of my application?

A: Enum support will not affect the performance of your application. The new enum schema type will be implemented in a way that is efficient and scalable, and will not introduce any performance bottlenecks.

Q: Can I customize the behavior of enum types?

A: Yes, you will be able to customize the behavior of enum types. This will provide flexibility in defining the allowed values for the enum type and implementing custom validation logic.

Q: How will enum support be documented?

A: We will provide comprehensive documentation on enum support in the Schemas package, including examples, tutorials, and API references. This will ensure that developers have the information they need to use enum types effectively.