Transform your PHP structures to TypeScript types

2.3.1 2024-05-03 07:58 UTC


Latest Version on Packagist Tests Styling PHPStan Total Downloads

This package allows you to convert PHP classes 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.

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

The Languages enum will be converted to:

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

You can find the full documentation here.

Support us


We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.


You can install this package via composer:

composer require spatie/typescript-transformer


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 instead of using the issue tracker.



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