Generate TypeScript interfaces from Laravel Models & Resources
MIT License
Generate TypeScript interfaces from Laravel Models & Resources
This resource:
use Illuminate\Http\Resources\Json\JsonResource;
/** @mixin \App\Models\Product */
class ProductResource extends JsonResource
{
public $showHiddenData = false;
public function toArray($request)
{
return [
'id' => $this->id,
'name' => $this->name,
'hidden' => $this->when($this->showHiddenData, false),
];
}
}
will be converted into this interface:
export interface ProductResourceType {
id: number;
name: string;
hidden?: boolean;
}
You can read the full documentation here.
You can install the package via composer:
composer require vagebond/runtype --dev
You can publish the config file with:
php artisan vendor:publish --tag="runtype-config"
php artisan runtype:generate
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.