Download the PHP package scrumble-nl/laravel-model-ts-type without Composer

On this page you can find all versions of the php package scrumble-nl/laravel-model-ts-type. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of scrumble-nl/laravel-model-ts-type

Informations about the package laravel-model-ts-type

laravel-model-ts-type

Generate TypeScript types based on your models.

Usage

Installation

Install the package using composer:

Generating types

Additional options:

Option Default value Description
modelDir app/Models The root directory where the package can find all Laravel models
outputDir resources/js/models The root directory for outputting the .d.ts files
namespace false The namespace of the generated Types. Use false if you don't prefer to have one
noKebabCase false Whether the file name should be formatted to kebab case
model null Choose to generate a model for a specific file. For example you can use App\Models\User
indentationSpaces 4 The amount of spaces used for indentation

If you want to change the default values you can publish the config file and change it to you liking.

NOTE: Do not forget to add the directory to your typeroots in tsconfig.json

What does it do?

This package takes (almost) all off Laravel's magic into account. It follows these steps for generating a Type:

  1. Retrieve all fields from te database (only MySQL/MariaDB supported) and map them to default types (string, number, etc.)
  2. Add relations for the Model, they will point to the related generated Type
  3. Add the attribute getters for the Model
  4. Check the casts attribute
  5. Remove all fields that are in the hidden attribute

Example output

Roadmap

Contributing

If you would like to see additions/changes to this package you are always welcome to add some code or improve it.

Scrumble

This product has been originally developed by Scrumble for internal use. As we have been using lots of open source packages we wanted to give back to the community. We hope this helps you getting forward as much as other people helped us!

All versions of laravel-model-ts-type with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-pdo Version *
laravel/framework Version ^10.0|^11.0
laravel/helpers Version ^1.6
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package scrumble-nl/laravel-model-ts-type contains the following files

Loading the files please wait ....