wthealth/laravel-enum-transformer

1.1.1 2023-03-06 08:02 UTC

Requires

• php: ^8.0
• ext-json: *
• bensampo/laravel-enum: ^5.0 || ^6.0
• spatie/typescript-transformer: ^2.1.3

Requires (Dev)

• phpunit/phpunit: ^9.5.10
• scrutinizer/ocular: ^1.8.1
• spatie/phpunit-snapshot-assertions: ^4.2.9
• symplify/easy-coding-standard: ^9.4

MIT

• Byron Adams

• enum
• typescript
• webtools
• typescript-transformer
• laravel-typescript-transformer

README

Adds transformation support for bensampo/laravel-enum based enums to the spatie/laravel-typescript-transformer package.

Installation & Configuration

 composer require wthealth/laravel-enum-transformer

Add the following Transformer to the configuration config/type-script-transformer

'transformers' => [
    Webtools\LaravelEnumTransformer\LaravelEnumTransformer::class,
],

Usage

Now any enum created based on BenSampo\Enum\Enum can be transformed to typescript like below

final class UserType extends Enum
{
    const Administrator = 0;
    const Moderator = 1;
    const Subscriber = 2;
    const SuperAdministrator = 3;
}

export type UserType = {
    Administrator = 0,
    Moderator = 1,
    Subscriber = 2,
    SuperAdministrator = 3,
}

Or transform to enums:

This must be enabled in config/type-script-transformer

'transform_to_native_enums' => true,

export enum UserType {
    Administrator = 0,
    Moderator = 1,
    Subscriber = 2,
    SuperAdministrator = 3,
}

Read the documentation for further details.

License

The MIT License (MIT). Please see License File for more information.