spatie / typescript-transformer
Transform your PHP structures to TypeScript types
Fund package maintenance!
spatie
spatie.be/open-source/support-us
Installs: 2 490 101
Dependents: 5
Suggesters: 0
Security: 0
Stars: 287
Watchers: 7
Forks: 36
Open Issues: 2
Requires
- php: ^8.0
- nikic/php-parser: ^4.18|^5.0
- phpdocumentor/type-resolver: ^1.6.2
- symfony/process: ^5.2|^6.0|^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.40
- larapack/dd: ^1.1
- myclabs/php-enum: ^1.7
- pestphp/pest: ^1.22
- phpstan/extension-installer: ^1.1
- phpunit/phpunit: ^9.0
- spatie/data-transfer-object: ^2.0
- spatie/enum: ^3.0
- spatie/pest-plugin-snapshots: ^1.1
- spatie/temporary-directory: ^1.2|^2.0
This package is auto-updated.
Last update: 2024-12-04 07:57:56 UTC
README
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.
Installation
You can install this package via composer:
composer require spatie/typescript-transformer
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.