Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
# typescriptify-laravel-models

Effortlessly generate TypeScript interface definitions from Laravel models.

## Example Usage

```php
<?php

use SalemC\TypeScriptifyLaravelModels\TypeScriptInterfaceGenerator;

echo TypeScriptInterfaceGenerator::generate(\App\Models\User::class);
```
Will produce:
```ts
interface User {
id: number;
name: string;
email: string;
email_verified_at: string|null;
password: string;
remember_token: string|null;
created_at: string|null;
updated_at: string|null;
}
```