README

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.

Installation

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"

Usage

php artisan runtype:generate

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

vagebond / runtype

Maintainers

Details