README

This package allows you to convert PHP classes and more to TypeScript.

This class...

#[TypeScript]
class User
{
    public int $id;
    public string $name;
    public ?string $address;
}

... will be converted to this TypeScript type:

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

Here's another example.

enum Languages: string
{
    case TYPESCRIPT = 'typescript';
    case PHP = 'php';
}

The Languages enum will be converted to:

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

And that's just the beginning! TypeScript transformer can handle complex types, generics and even allows you to create TypeScript functions.

You can find the full documentation here.

Testing

composer test

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

Please see CONTRIBUTING for details.

If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker.

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