spatie / laravel-typescript-transformer by spatie

Transform your PHP structures to TypeScript types

2,082,658

241

spatie typescript-transformer

Package Data
Maintainer Username:	spatie
Maintainer Contact:	ruben@spatie.be (Ruben Van Assche)
Package Create Date:	2020-06-29
Package Last Update:	2024-10-04
Home Page:	https://docs.spatie.be/typescript-transformer/v2/introduction/
Language:	PHP
License:	MIT
Last Refreshed:	2024-11-17 03:06:58

Transform PHP types to TypeScript

Always wanted type safety within PHP and TypeScript without duplicating a lot of code? Then you will like this package! Let's say you have an enum:

class Languages extends Enum
{
    const TYPESCRIPT = 'typescript';
    const PHP = 'php';
}

Wouldn't it be cool if you could have an automatically generated TypeScript definition like this:

export type Languages = 'typescript' | 'php';

This package will automatically generate such definitions for you, the only thing you have to do is adding this annotation:

/** @typescript **/
class Languages extends Enum
{
    const TYPESCRIPT = 'typescript';
    const PHP = 'php';
}

You can even take it a bit further and generate TypeScript from classes:

/** @typescript */
class User
{
    public int $id;

    public string $name;

    public ?string $address;
}

This will be transformed to:

export type User = {
    int: number;
    name: string;
    address: string | null;
}

Want to know more? You can find the documentation here.

composer test

Please see CHANGELOG for more information on what has changed recently.

Please see CONTRIBUTING for details.

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

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