Type Mappings

laravel-typescript comes with sensible defaults for mapping database and PHP types to TypeScript, but you have full control over these mappings.

Default Mappings

PHP/DB Type	TypeScript Type
string, char, text	string
int, integer, bigint, float, double	number
bool, boolean	boolean
date, datetime, timestamp	string
json, array	any

Custom Type Mappings

You can override any type mapping in your config/typescript.php:

'mappings' => [
    'custom' => [
        'point' => '{ lat: number; lng: number }',
        'money' => 'string',
        'decimal' => 'number',
    ],
],

Model-Level Overrides ($interfaces)

Use model-level overrides when a specific field needs a custom TypeScript type.

class Message extends Model
{
    public array $interfaces = [
        // Shorthand form
        'metadata' => 'Record<string, unknown>',

        // Object form
        'attachments' => [
            'type' => 'MessagePartAttachment[]',
            'import' => '@/types/ai',
        ],

        // Nullable forced type
        'avatar' => [
            'type' => 'ImageAsset',
            'nullable' => true,
            'import' => '@/types/media',
        ],
    ];
}

Supported object keys:

• type (string): Forced TypeScript type.
• import (string): Module path used to generate import type statements.
• nullable (bool): Overrides nullability for the forced type.

Notes:

• You can mix shorthand string entries and object entries.
• Imports are deduplicated, so identical type + import pairs are emitted once per generated file.
• Overrides take highest precedence in type resolution.

Global Type Overrides

Timestamps as Date

By default, timestamps are generated as string. You can change this globally to Date:

'mappings' => [
    'timestamps_as_date' => true,
],

Decimals as String

If you use high-precision decimals and want to avoid precision loss in JavaScript, you can map them all to string:

'mappings' => [
    'decimals_as_string' => true,
],