Spatie TypeScript Transformer

https://github.com/spatie/typescript-transformer
Admin
A PHP package that transforms PHP classes and types into TypeScript type definitions.
Tokens:96,028
Snippets:724
Trust Score:10
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Generated TypeScriptTransformerServiceProvider

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/installation-and-setup.md

This is the initial service provider created by the install command. The configure method is where you will add your configuration, starting with the $config object.

```php
class TypeScriptTransformerServiceProvider extends BaseTypeScriptTransformerServiceProvider
{
    protected function configure(TypeScriptTransformerConfigFactory $config): void
    {
        $config; // We'll come back to this in a minute
    }
}
```

--------------------------------

### Install chokidar with yarn

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/watch-mode/how-it-works.md

Alternative installation of chokidar using yarn.

```bash
yarn add chokidar
```

--------------------------------

### Install chokidar with npm

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/watch-mode/how-it-works.md

Install the chokidar package using npm, required for watch mode.

```bash
npm install chokidar
```

--------------------------------

### Install spatie/typescript-transformer via Composer

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/installation.md

Use this command to install the base package. Requires Composer.

```bash
composer require spatie/typescript-transformer
```

--------------------------------

### ClosureRouteFilter example

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/route-filters.md

Provides a closure that receives each route and returns true to exclude it. The example excludes routes whose URI starts with 'internal/'.

```php
use Spatie\LaravelTypeScriptTransformer\RouteFilters\ClosureRouteFilter;

new ClosureRouteFilter(function (Route $route) {
    return str_starts_with($route->uri(), 'internal/');
}),
```

--------------------------------

### ModuleWriter output example

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/first-run.md

Example output from the ModuleWriter, which creates a file per location. Each file contains types without namespaces.

```ts
// app/data/index.d.ts
export type PostData = {
    title: string;
    slug: string;
    type: App.Enums.PostType;
    tags: Array<string>;
    publish_date: string | null;
    published: boolean;
};

// app/enums/index.d.ts
export type PostType = 'news' | 'blog';
```

--------------------------------

### Install spatie/laravel-typescript-transformer via Composer

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/installation.md

Use this command instead if you are using Laravel. This installs the Laravel-specific package.

```bash
composer require spatie/laravel-typescript-transformer
```

--------------------------------

### Install TypeScriptTransformerServiceProvider

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/installation-and-setup.md

Run this artisan command to create the TypeScriptTransformerServiceProvider in the app/Providers directory and register it in bootstrap/providers.php (Laravel 11+) or config/app.php (Laravel 10 or below).

```bash
php artisan typescript:install
```

--------------------------------

### GlobalNamespaceWriter output example

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/first-run.md

Example output from the GlobalNamespaceWriter, which generates a single .d.ts file with all types in namespaces based on their location.

```ts
declare namespace App.Data {
    export type PostData = {
        title: string;
        slug: string;
        type: App.Enums.PostType;
        tags: Array<string>;
        publish_date: string | null;
        published: boolean;
    };
}
declare namespace App.Enums {
    export type PostType = 'news' | 'blog';
}
```

--------------------------------

### Get a PHP node with get()

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/watch-mode/php-nodes.md

Retrieves a PhpClassNode from the collection by its fully qualified class name (FQCN).

```php
$node = $this->phpNodeCollection->get($fqcn);
```

--------------------------------

### Example PostsController with index, show, and store actions

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

A sample controller with three actions: index returns a LengthAwarePaginator, show takes a string parameter and returns PostData, store takes PostData and returns PostData. This controller is used to demonstrate the generated TypeScript.

```php
class PostsController
{
    public function index(): LengthAwarePaginator
    {
        // ...
    }

    public function show(string $post): PostData
    {
        // ...
    }

    public function store(PostData $data): PostData
    {
        // ...
    }
}
```

--------------------------------

### Calling show action with route parameter

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

Actions with route parameters require them as the first argument. The example shows passing `{ post: 1 }` and the resulting URL.

```ts
const { url, method } = PostsController.show({ post: 1 });
// { url: '/posts/1', method: 'get' }
```

--------------------------------

### Example node tree for visitor traversal

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/visitor.md

A TypeScriptUnion node containing a TypeScriptString and TypeScriptNumber. Used as the root node for the visitor example.

```php
$rootNode = new TypeScriptUnion([
    new TypeScriptString(),
    new TypeScriptNumber(),
]);
```

--------------------------------

### Using Request and Response types for store action

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

The generated namespace for each action contains `Request` and `Response` types. This example shows how to use them to type frontend code, including a fetch call.

```ts
import { PostsController } from './controllers';

async function createPost(data: PostsController.store.Request) {
    const { url, method } = PostsController.store();

    const response = await fetch(url, {
        method,
        body: JSON.stringify(data),
    });

    return await response.json() as PostsController.store.Response;
}
```

--------------------------------

### Resolve imports and references with ResolveImportsAndResolvedReferenceMapAction

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/advanced/custom-writers.md

Uses the action to get imports and a resolved reference map for the current file. The currentPath should be the file being written, e.g., 'app/models/index.ts'.

```php
use Spatie\TypeScriptTransformer\Actions\ResolveImportsAndResolvedReferenceMapAction;

[$imports, $resolvedReferenceMap] = (new ResolveImportsAndResolvedReferenceMapAction())->execute(
    currentPath: $currentPath, // e.g. 'app/models/index.ts'
    transformed: $transformed,
    transformedCollection: $transformedCollection,
);
```

--------------------------------

### Implement WatchingTransformedProvider interface

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/watch-mode/watch-events.md

Example of a custom provider implementing the WatchingTransformedProvider and TransformedProvider interfaces. It defines directoriesToWatch() to return the directories to watch and handleWatchEvent() to process watch events, returning null for non-summarized events.

```php
use Spatie\TypeScriptTransformer\TransformedProviders\WatchingTransformedProvider;
use Spatie\TypeScriptTransformer\Data\WatchEventResult;
use Spatie\TypeScriptTransformer\Events\SummarizedWatchEvent;

class CustomWatchableProvider implements WatchingTransformedProvider, TransformedProvider
{
    public function directoriesToWatch(): array
    {

        return [__DIR__.'/models'];
    }

    public function handleWatchEvent(WatchEvent $watchEvent, TransformedCollection $transformedCollection): ?WatchEventResult
    {
        if(! $watchEvent instanceof SummarizedWatchEvent){
            return null;
        }

        // Handle changes to the TransformedCollection
    }
}
```

--------------------------------

### Passing query parameters to index action

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

Query parameters can be passed via the options argument. The example shows passing `{ query: { page: 2, per_page: 15 } }` and the resulting URL.

```ts
const { url } = PostsController.index({ query: { page: 2, per_page: 15 } });
// '/posts?page=2&per_page=15'
```

--------------------------------

### Run TypeScript transformer in watch mode

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/watch-mode.md

Use this command to start watch mode, which monitors PHP files and automatically updates the generated TypeScript files whenever changes are detected.

```bash
php artisan typescript:transform --watch
```

--------------------------------

### GenerateTypeScriptCommand with watch and worker options

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/watch-mode/setting-up-the-runner.md

Defines a Symfony console command that runs the TypeScript transformer with modes for direct, master, and worker processes. The --watch option starts the master process, and --worker is used internally by the master to start the worker. The workerCommand closure can be adjusted to match your command structure.

```php
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class GenerateTypeScriptCommand extends Command
{
    protected static $defaultName = 'typescript:transform';

    protected function configure(): void
    {
        $this
            ->setDescription('Transform TypeScript types')
            ->addOption('watch', 'w', InputOption::VALUE_NONE, 'Watch for file changes')
            ->addOption('worker', null, InputOption::VALUE_NONE, 'Run as worker process');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $runner = new Runner();

        $config = TypeScriptTransformerConfigFactory::create()->get();

        return $runner->run(
            logger: new SymfonyConsoleLogger($output),
            config: $config,
            mode: match ([$input->getOption('watch'), $input->getOption('worker')]) {
                [false, false] => RunnerMode::Direct,
                [true, false] => RunnerMode::Master,
                [true, true] => RunnerMode::Worker,
                default => throw new \Exception('A worker only needs to be started in watch mode.'),
            },
            workerCommand: fn (bool $watch) => 'bin/console typescript:transform --worker '.($watch ? '--watch ' : ''),
        );
    }
}
```

--------------------------------

### Generated TypeScript for CustomReference

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/providers/references.md

The resulting TypeScript output for the custom reference example, showing the namespace and type alias.

```ts
namespace App.Languages {
    export type Type = 'PHP' | 'TypeScript';
}
```

--------------------------------

### Implement ClassPropertyProcessor interface

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/class-transformer.md

Create a class property processor by implementing the `ClassPropertyProcessor` interface. The example `RemoveNullProcessor` removes null types from a union type. This allows fine-grained control over how a property is transformed.

```php
use Spatie\TypeScriptTransformer\Transformers\ClassPropertyProcessors\ClassPropertyProcessor;

class RemoveNullProcessor implements ClassPropertyProcessor
{
    public function execute(
        PhpPropertyNode $phpPropertyNode,
        ?TypeNode $annotation,
        TypeScriptProperty $property
    ): ?TypeScriptProperty {
        if ($property->type instanceof TypeScriptUnion) {
            $property->type = new TypeScriptUnion(
                array_values(array_filter($property->type->types, fn (TypeScriptNode $type) => !$type instanceof TypeScriptNull))
            );
        }

        return $property;
    }
}
```

--------------------------------

### NamedRouteFilter example

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/route-filters.md

Excludes routes by name, supporting wildcards. The example filters routes named 'debugbar.*' and 'admin.*'.

```php
use Spatie\LaravelTypeScriptTransformer\RouteFilters\NamedRouteFilter;

new NamedRouteFilter('debugbar.*', 'admin.*'),
```

--------------------------------

### ControllerRouteFilter example

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/route-filters.md

Excludes routes by controller class or namespace, supporting wildcards. The example filters controllers under 'App\Http\Controllers\Admin\*' and the 'HiddenController' class.

```php
use Spatie\LaravelTypeScriptTransformer\RouteFilters\ControllerRouteFilter;

new ControllerRouteFilter('App\Http\Controllers\Admin\*', 'HiddenController'),
```

--------------------------------

### Get TypeScript import nodes

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/advanced/custom-writers.md

Converts the collection of imports into TypeScript import nodes.

```php
$imports->getTypeScriptNodes()
```

--------------------------------

### Customize route directories for Laravel controller watch mode

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

Specifies which directories are watched for route definitions. By default, the provider watches 'routes/', 'bootstrap/', and 'app/Providers/'. This example only watches the 'routes' directory.

```php
$config->provider(new LaravelControllerTransformedProvider(
    routeDirectories: [
        base_path('routes'),
    ],
));
```

--------------------------------

### Set location with #[TypeScript(location: ['Data', 'Users'])]

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/attributes.md

Use the #[TypeScript] attribute with the location parameter to change where the type is placed in the TypeScript output. The example places the User type in the Data.Users namespace.

```php
#[TypeScript(location: ['Data', 'Users'])]
class User
{
    public int $id;
    public string $name;
}
```

```ts
declare namespace Data.Users {
    export type User = {
        id: number;
        name: string;
    };
}
```

--------------------------------

### ControllerRouteFilter with specific actions

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/route-filters.md

Filters specific controller actions using a tuple of [class, method]. The example excludes the 'destroy' and 'edit' actions of PostsController.

```php
new ControllerRouteFilter(
    [PostsController::class, 'destroy'],
    [PostsController::class, 'edit'],
)
```

--------------------------------

### AddLaravelCollectionProvider implementation

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/providers/getting-started.md

Example provider that adds a generic type for Laravel collections. It creates a Transformed object with a TypeScriptAlias node and returns it.

```php
class AddLaravelCollectionProvider implements TransformedProvider
{
    public function provide(): array
    {
        $type = new Transformed(
            typeScriptNode: new TypeScriptAlias(
                new TypeScriptGeneric(
                    new TypeScriptIdentifier('Collection'),
                    [new TypeScriptIdentifier('T')],
                ),
                new TypeScriptGeneric(
                    new TypeScriptIdentifier('Array'),
                    [new TypeScriptIdentifier('T')],
                ),
            ),
            reference: new ClassStringReference(Collection::class),
            location: ['Illuminate', 'Support']
        ));

        return [$type];
    }
}
```

--------------------------------

### Routes for PostsController actions

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

Routes that map GET and POST requests to the controller actions. These routes determine the URL and HTTP method for each generated TypeScript function.

```php
Route::get('posts', [PostsController::class, 'index']);
Route::get('posts/{post}', [PostsController::class, 'show']);
Route::post('posts', [PostsController::class, 'store']);
```

--------------------------------

### Override getProperties to choose properties

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/class-transformer.md

Override the getProperties method to change which properties are transformed. By default, all public non-static properties are used; this example includes public and protected properties.

```php
protected function getProperties(PhpClassNode $phpClassNode): array
{
    return $phpClassNode->getProperties(ReflectionProperty::IS_PUBLIC|ReflectionProperty::IS_PROTECTED);
}
```

--------------------------------

### Override classPropertyProcessors to add processors

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/class-transformer.md

Overwrite the `classPropertyProcessors` method to add your custom processors to the transformer. The example returns an array containing a new `RemoveNullProcessor` instance.

```php
protected function classPropertyProcessors(): array
{
    return [
        new RemoveNullProcessor(),
    ];
}
```

--------------------------------

### Implement TypeScriptForwardingNamedNode in TypeScriptAlias

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/custom-nodes.md

Example of a node that forwards its named node via getForwardedNamedNode. The write method outputs a TypeScript type alias, and the forwarded node is the identifier property.

```php
class TypeScriptAlias implements TypeScriptForwardingNamedNode, TypeScriptNode
{
    public function __construct(
        public TypeScriptIdentifier|TypeScriptGeneric $identifier,
        public TypeScriptNode $type,
    ) {
    }

    public function write(WritingContext $context): string
    {
        return "type {$this->identifier->write($context)} = {$this->type->write($context)};";
    }

    public function getForwardedNamedNode(): TypeScriptNamedNode|TypeScriptForwardingNamedNode
    {
        return $this->identifier;
    }
}
```

--------------------------------

### Symfony command to generate TypeScript types

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/setting-up.md

Creates a Symfony console command that runs the TypeScript transformer. It uses the Runner class with a SymfonyConsoleLogger and RunnerMode::Direct. The configuration is obtained from TypeScriptTransformerConfigFactory::create()->get().

```php
use Spatie\TypeScriptTransformer\Enums\RunnerMode;
use Spatie\TypeScriptTransformer\Runners\Runner;
use Spatie\TypeScriptTransformer\Support\Console\SymfonyConsoleLogger;
use Spatie\TypeScriptTransformer\TypeScriptTransformerConfigFactory;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class GenerateTypeScriptCommand extends Command
{
    protected static $defaultName = 'typescript:transform';

    protected function configure(): void
    {
        $this->setDescription('Transform TypeScript types');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $runner = new Runner();

        $config = TypeScriptTransformerConfigFactory::create()->get(); // We'll come back to this in a minute

        return $runner->run(
            logger: new SymfonyConsoleLogger($output),
            config: $config,
            mode: RunnerMode::Direct,
        );
    }
}
```

--------------------------------

### Basic Visitor with before and after callbacks

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/visitor.md

Creates a Visitor and registers before and after callbacks that print the node class name. The before callback runs before visiting children, the after callback runs after.

```php
use Spatie\TypeScriptTransformer\Visitor\Visitor;

Visitor::create()
    ->before(function (TypeScriptNode $node){
        echo 'Before visiting ' . $node::class . PHP_EOL;
    })
    ->after(function (TypeScriptNode $node) {
        echo 'After visiting ' . $node::class . PHP_EOL;
    })
    ->execute($rootNode);
```

--------------------------------

### Override isPropertyOptional to make properties optional

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/class-transformer.md

Override the isPropertyOptional method to define custom logic for making properties optional in TypeScript. This example makes properties whose names start with an underscore optional. By default, the transformer checks for an #[Optional] attribute.

```php
protected function isPropertyOptional(
    PhpPropertyNode $phpPropertyNode,
    PhpClassNode $phpClassNode,
    TypeScriptNode $type,
    TransformationContext $context,
): bool {
    return str_starts_with($phpPropertyNode->getName(), '_');
}
```

--------------------------------

### Run tests

Source: https://github.com/spatie/typescript-transformer/blob/main/README.md

Run the package's test suite.

```bash
composer test
```

--------------------------------

### Write imports and transformed objects to output

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/advanced/custom-writers.md

Builds the output string by writing each import and transformed item, then creates a WriteableFile with the file path and output.

```php
$output = '';

foreach ($imports->getTypeScriptNodes() as $import) {
    $output .= $import->write($writingContext).PHP_EOL;
}

foreach ($location->transformed as $transformedItem) {
    $output .= $transformedItem->write($writingContext).PHP_EOL;
}

$writeableFile = new WriteableFile($filePath, $output);
```

--------------------------------

### Hooking visitors before transformer steps

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/visitor.md

Registers providedVisitorHook and connectedVisitorHook with VisitorClosureType::Before to run a visitor before the reference connection step.

```php
use Spatie\TypeScriptTransformer\Visitor\VisitorClosureType;

$config->providedVisitorHook(
    fn(TransformedCollection $collection) => Visitor::create()->execute($collection),
    [TypeScriptUnion::class],
    VisitorClosureType::Before
);

$config->connectedVisitorHook(
    fn(TransformedCollection $collection) => Visitor::create()->execute($collection),
    [TypeScriptUnion::class],
    VisitorClosureType::Before
);
```

--------------------------------

### Converted TypeScript type for Languages enum

Source: https://github.com/spatie/typescript-transformer/blob/main/README.md

The resulting TypeScript type from the Languages enum example, represented as a union of string literals.

```tsx
export type Languages = 'typescript' | 'php';
```

--------------------------------

### Logger methods with different log levels

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/providers/logging.md

Demonstrates the available logger methods: debug, info, warning, and error. Each method takes an item (any JSON encodable type) and an optional title for context.

```php
$this->logger->debug($transfomed->getReference(), 'Transformed reference details');
$this->logger->info($transfomed->getNode(), 'TypeScript node details');
$this->logger->warning($transfomed->getName(), 'Potential issue with transformed item');
$this->logger->error($transfomed->isChanged(), 'Error encountered during transformation');
```

--------------------------------

### Run TypeScript transformation

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/installation-and-setup.md

This command transforms your PHP types into TypeScript. Without configuration, it won't do anything.

```bash
php artisan typescript:transform
```

--------------------------------

### TransformedCollection

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/watch-mode/watch-events.md

Collection of transformed objects with methods to add, check, get, remove, and find transformed objects, as well as request a complete rewrite.

```APIDOC
## TransformedCollection

### Description
Provides methods to manage transformed objects within the collection, making it easier to update based on detected changes.

### Methods

#### add
Adds new transformed objects to the collection. If a transformed object with the same reference already exists, it will be replaced.

**Signature:** `public function add(Transformed ...$transformed): void`

**Parameters:**
- **...$transformed** (Transformed) - One or more transformed objects to add.

#### has
Checks whether a transformed object with the given reference exists in the collection.

**Signature:** `public function has(Reference|string $reference): bool`

**Parameters:**
- **$reference** (Reference|string) - The reference to check.

**Returns:** `bool` - True if the transformed object exists, false otherwise.

#### get
Gets a transformed object by its reference. Returns null when no transformed object was found.

**Signature:** `public function get(Reference|string $reference): ?Transformed`

**Parameters:**
- **$reference** (Reference|string) - The reference to retrieve.

**Returns:** `?Transformed` - The transformed object or null.

#### remove
Removes a transformed object from the collection by its reference. If that transformed object is referenced by other transformed objects, these references will be removed as well and tagged to be missing. If later on a new transformed object is added with the same reference, these missing references will be resolved automatically.

**Signature:** `public function remove(Reference|string $reference): void`

**Parameters:**
- **$reference** (Reference|string) - The reference to remove.

#### findTransformedByFile
Finds the current transformed object for a given file path. Useful when a file was updated. Each Reference implementation can implement the `FilesystemReference` interface which provides the file path of the referenced object.

**Signature:** `public function findTransformedByFile(string $path): ?Transformed`

**Parameters:**
- **$path** (string) - The file path to search for.

**Returns:** `?Transformed` - The transformed object or null.

#### findTransformedByDirectory
Finds all transformed objects within a given directory.

**Signature:** `public function findTransformedByDirectory(string $path): Generator`

**Parameters:**
- **$path** (string) - The directory path to search within.

**Returns:** `Generator` - A generator yielding transformed objects.

#### requireCompleteRewrite
Requests a complete rewrite of the transformed collection. While caching is used to invalidate only changed objects and their dependents, sometimes a complete rewrite is necessary.

**Signature:** `public function requireCompleteRewrite(): void`
```

--------------------------------

### Visitor output for union node traversal

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/visitor.md

Shows the order of before and after callbacks when visiting the union node and its children.

```text
Before visiting TypeScriptUnion
Before visiting TypeScriptString
After visiting TypeScriptString
Before visiting TypeScriptNumber
After visiting TypeScriptNumber
After visiting TypeScriptUnion
```

--------------------------------

### Converted TypeScript type for User class

Source: https://github.com/spatie/typescript-transformer/blob/main/README.md

The resulting TypeScript type from the User class example. The nullable property becomes a union type with null.

```ts
export type User = {
    id: number;
    name: string;
    address: string | null;
}
```

--------------------------------

### Hooking visitors after transformer steps

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/visitor.md

Registers providedVisitorHook and connectedVisitorHook with VisitorClosureType::After to run a visitor after the reference connection step.

```php
$config->providedVisitorHook(
    fn(TransformedCollection $collection) => Visitor::create()->execute($collection),
    [TypeScriptUnion::class],
    VisitorClosureType::After
);

$config->connectedVisitorHook(
    fn(TransformedCollection $collection) => Visitor::create()->execute($collection),
    [TypeScriptUnion::class],
    VisitorClosureType::After
);
```

--------------------------------

### Register extension in configuration

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/advanced/extensions.md

Register the custom extension with the configuration using the extension method.

```php
$config->extension(new MyExtension());
```

--------------------------------

### Add PHP node from file with addByFile()

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/watch-mode/php-nodes.md

Adds a PHP class node to the collection from a file path. The file must contain exactly one class, interface, or enum; otherwise the method returns null.

```php
$this->phpNodeCollection->addByFile($filePath);
```

--------------------------------

### Run the typescript:transform command

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/setting-up.md

Executes the registered Symfony command. Without configuration, it will not perform any transformation.

```bash
php bin/console typescript:transform
```

--------------------------------

### Implement a custom provider using TransformedProviderActions

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/providers/helpers.md

Shows how to create a custom provider that implements ActionAwareTransformedProvider and uses the parseUserDefinedTypeAction to parse a user-defined type string into a TypeScript node. The setActions method is required to receive the actions object.

```php
use Spatie\TypeScriptTransformer\TransformedProviders\ActionAwareTransformedProvider;
use Spatie\TypeScriptTransformer\TransformedProviders\TransformedProviderActions;
use Spatie\TypeScriptTransformer\TransformedProviders\TransformedProvider;

class CustomProvider implements TransformedProvider, ActionAwareTransformedProvider
{
    private TransformedProviderActions $actions;

    public function setActions(TransformedProviderActions $actions): void
    {
        $this->actions = $actions;
    }

    public function provide(): array
    {
        $classNode = $this->actions->parseUserDefinedTypeAction->execute('Record<string, int>');
    }
}
```

--------------------------------

### Override isPropertyHidden to hide properties

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/class-transformer.md

Overwrite the `isPropertyHidden` method to hide a property from the TypeScript object. The example returns true when the property has an `#[Hidden]` attribute. By default, the transformer checks for the `#[Hidden]` attribute.

```php
protected function isPropertyHidden(
    PhpPropertyNode $phpPropertyNode,
    PhpClassNode $phpClassNode,
    TypeScriptProperty $property,
): bool {
    return count($phpPropertyNode->getAttributes(Hidden::class)) > 0;
}
```

--------------------------------

### Add directories to scan for PHP classes

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/first-run.md

Adds a directory to the configuration so the transformer knows where to look for PHP classes. Here, app_path() is used.

```php
$config->transformDirectories(app_path());
```

--------------------------------

### Prepend a transformer with prependTransformer()

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/advanced/managing-transformers.md

Adds a transformer to the beginning of the transformer list, giving it priority over others. Use this when your transformer should take precedence.

```php
$config->prependTransformer(new HighPriorityTransformer());
```

--------------------------------

### CustomProvider

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/providers/helpers.md

This snippet shows how to implement a custom transformed provider using the TransformedProviderActions object.

```APIDOC
## [CustomProvider] [CustomProvider]

### Description
This code snippet demonstrates how to create a custom transformed provider that uses the `TransformedProviderActions` object to access actions like transpiling PHP types to TypeScript and parsing user-defined types.

### Method
Not applicable (PHP class implementation)

### Endpoint
Not applicable (PHP class implementation)

### Parameters
#### Class Properties
- **$actions** (TransformedProviderActions) - Required - The actions object provided by the framework.

#### Methods
- **setActions(TransformedProviderActions $actions): void** - Required - Sets the actions object.
- **provide(): array** - Required - Returns an array of transformed types.

### Request Example
```php
use Spatie\TypeScriptTransformer\TransformedProviders\ActionAwareTransformedProvider;
use Spatie\TypeScriptTransformer\TransformedProviders\TransformedProviderActions;
use Spatie\TypeScriptTransformer\TransformedProviders\TransformedProvider;

class CustomProvider implements TransformedProvider, ActionAwareTransformedProvider
{
    private TransformedProviderActions $actions;

    public function setActions(TransformedProviderActions $actions): void
    {
        $this->actions = $actions;
    }

    public function provide(): array
    {
        $classNode = $this->actions->parseUserDefinedTypeAction->execute('Record<string, int>');
    }
}
```

### Response
#### Success Response (200)
- **array** - The array of transformed types.

#### Response Example
Not applicable (PHP class implementation)

### Error Handling
No error handling is documented for this snippet.
```

--------------------------------

### Configure ModuleWriter

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/first-run.md

Configures the writer to use ModuleWriter, which creates a file per location.

```php
$config->writer(new ModuleWriter());
```

--------------------------------

### Make all properties optional with class-level #[Optional]

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/typing-properties.md

Shows how to make all properties optional by adding the #[Optional] attribute to the class.

```php
#[Optional]
class Types
{
    public string $property;
}
```

--------------------------------

### StrippedActionNameResolver with replacement string

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

Shows how to provide a replacement string instead of null. The prefix 'App\Http\Controllers' is replaced with 'controllers', so 'App\Http\Controllers\Posts\PostsController' becomes 'controllers/Posts/PostsController'.

```php
new StrippedActionNameResolver([
    'App\Http\Controllers' => 'controllers',
])
// App\Http\Controllers\Posts\PostsController → controllers/Posts/PostsController
```

--------------------------------

### Implement the Writer interface

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/advanced/custom-writers.md

Defines the contract for a custom writer. The output method returns an array of WriteableFile objects, and resolveReference provides a reference for a transformed object.

```php
use Spatie\TypeScriptTransformer\Data\WriteableFile;

interface Writer
{
/**
     * @param array<Transformed> $transformed
     *
     * @return array<WriteableFile>
     */
    public function output(
        array $transformed,
        TransformedCollection $transformedCollection,
    ): array;

    public function resolveReference(Transformed $transformed): ModuleImportResolvedReference|GlobalNamespaceResolvedReference;
}
```

--------------------------------

### Class property processor to remove properties

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/class-transformer.md

A class property processor can also remove properties from the TypeScript object by returning null. The example `RemoveAllStrings` returns null when the property type is `TypeScriptString`, effectively removing it.

```php
class RemoveAllStrings implements ClassPropertyProcessor
{
    public function execute(
        PhpPropertyNode $phpPropertyNode,
        ?TypeNode $annotation,
        TypeScriptProperty $property
    ): ?TypeScriptProperty {
        if ($property->type instanceof TypeScriptString) {
            return null;
        }

        return $property;
    }
}
```

--------------------------------

### Creating a Transformed object

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/getting-started.md

Shows how to return a Transformed data object with the TypeScript node, reference, location, and export flag.

```php
use Spatie\TypeScriptTransformer\References\ClassStringReference;

new Transformed(
    // The TypeScript node representing the transformed class
    typeScriptNode: $typeScriptNode,
    // A unique name for the transformed class for internal package use
    reference: new ClassStringReference($reflectionClass->getName()),
    // A location where the class should be written to
    // By default, this is the namespace of the class and the $nameSpaceSegments from the TransformationContext can be used
    location: $context->nameSpaceSegments,
    // Whether the type should be exported in TypeScript
    export: true,
);
```

--------------------------------

### TypeScriptObjectLiteral constructor

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/reference.md

Creates a TypeScriptObjectLiteral node for JSON object values like `{ "method": "GET", "url": "/users" }`. Use for value-level objects, not type-level shapes.

```php
new TypeScriptObjectLiteral(['method' => 'GET', 'url' => '/users'])
```

--------------------------------

### ClosureActionNameResolver custom path segments

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

Uses the ClosureActionNameResolver to define a custom resolver that receives the controller class name and returns an array of path segments. The example returns ['api', class_basename($controllerClass)], resulting in paths like 'api/PostsController'.

```php
use Spatie\LaravelTypeScriptTransformer\ActionNameResolvers\ClosureActionNameResolver;

$config->provider(new LaravelControllerTransformedProvider(
    actionNameResolver: new ClosureActionNameResolver(
        fn (string $controllerClass) => ['api', class_basename($controllerClass)]
    ),
));
```

--------------------------------

### Implement LoggingTransformedProvider with setLogger

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/providers/logging.md

Shows a custom provider implementing LoggingTransformedProvider and TransformedProvider. The setLogger method receives a Logger instance, which is stored and used to log info messages during the provide method.

```php
use Spatie\TypeScriptTransformer\TransformedProviders\LoggingTransformedProvider;
use Spatie\TypeScriptTransformer\Support\Loggers\Logger;

class CustomTransformedProvider implements LoggingTransformedProvider, TransformedProvider
{
    protected Logger $logger;

    public function setLogger(Logger $logger): void
    {
        $this->logger = $logger;
    }

    public function provide(
        TypeScriptTransformerConfig $config,
    ): array {
        $this->logger->info('Starting transformation process in CustomTransformedProvider.');

        // Some of

        $this->logger->info('Finished transformation process in CustomTransformedProvider.');
    }
}
```

--------------------------------

### Implement the Logger interface

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/advanced/loggers.md

To create a custom logger, implement the Logger interface with methods debug, info, warning, and error. Each method accepts a mixed item and an optional title parameter.

```php
namespace Spatie\TypeScriptTransformer\Support\Loggers;

interface Logger
{
    public function debug(mixed $item, ?string $title = null): void;

    public function info(mixed $item, ?string $title = null): void;

    public function warning(mixed $item, ?string $title = null): void;

    public function error(mixed $item, ?string $title = null): void;
}
```

--------------------------------

### Override isPropertyReadonly to make properties readonly

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/class-transformer.md

Overwrite the `isPropertyReadonly` method to define custom logic for making a property readonly. The example returns true when the property name ends with 'Read'. By default, the transformer checks whether a property was made readonly in PHP.

```php
protected function isPropertyReadonly(
    PhpPropertyNode $phpPropertyNode,
    PhpClassNode $phpClassNode,
    TypeScriptNode $type,
): bool {
   return str_ends_with($phpPropertyNode->getName(), 'Read');
}
```

--------------------------------

### Implement TypeScriptNode and TypeScriptNamedNode in PickNode

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/custom-nodes.md

Shows a minimal custom node that implements both TypeScriptNode and TypeScriptNamedNode. The write method converts the node to a TypeScript string, and getName returns the node's name for reference by other nodes.

```php
use Spatie\TypeScriptTransformer\Data\WritingContext;
use Spatie\TypeScriptTransformer\TypeScriptNodes\TypeScriptNamedNode;
use Spatie\TypeScriptTransformer\TypeScriptNodes\TypeScriptNode;

class PickNode implements TypeScriptNode, TypeScriptNamedNode
{
    public function __construct(
        private TypeScriptNode $type,
        private array $properties,
    ) {}

    public function write(WritingContext $context): string
    {
        return 'Pick<' . $this->type->write($context) . ', ' . implode(' | ', $this->properties) . '>';
    }

    public function getName(): string
    {
        return 'Pick';
    }
}
```

--------------------------------

### TransformationContext class

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/getting-started.md

Provides the name and namespace segments for the class being transformed.

```php
class TransformationContext
{
    public function __construct(
        // The name for the class that is being transformed, can be user defined
        public string $name,
        // The segments of the namespace where the class is located
        public array $nameSpaceSegments,
    ) {
    }
}
```

--------------------------------

### Set output directory

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/first-run.md

Sets the directory where the generated TypeScript files will be written.

```php
$config->outputDirectory(__DIR__.'/generated');
```

--------------------------------

### Configure route filters in provider

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/route-filters.md

Shows how to pass route filters to the LaravelRouteTransformedProvider and LaravelControllerTransformedProvider via their configuration.

```php
$config->provider(new LaravelRouteTransformedProvider(
    routeFilters: [
        // ...
    ],
));

$config->provider(new LaravelControllerTransformedProvider(
    filters: [
        // ...
    ],
));
```

--------------------------------

### Import multiple names from same file

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/typing-properties.md

Shows how to import multiple names from the same file using the AdditionalImport attribute with an array of names.

```php
new AdditionalImport(__DIR__.'/../types/components.ts', ['SomeComponent', 'OtherThing'])
```

--------------------------------

### Add an existing PHP node with add()

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/watch-mode/php-nodes.md

Adds an already loaded PhpClassNode directly to the collection.

```php
$this->phpNodeCollection->add($phpClassNode);
```

--------------------------------

### Customize route watch directories

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/routes.md

Customize the directories monitored by the watcher for route changes.

```php
$config->provider(new LaravelRouteTransformedProvider(
    routeDirectories: [
        'custom/routes/directory',
        'another/directory/to/watch',
    ],
));
```

--------------------------------

### Property annotation locations

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/typing-properties.md

Shows three locations where property annotations can be added: class-level @property, property-level @var, and constructor parameter @param.

```php
/**
* @property string[] $propertyA
 */
class Types
{
    public array $propertyA;

    /** @var string[] */
    public array $propertyB;

    /**
    * @param string[] $propertyC
     */
    public function __construct(
        public array $propertyC
    ) {

    }
}
```

--------------------------------

### Create TypeScriptRaw nodes

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/reference.md

Creates raw TypeScript pass-through nodes. Supports %placeholder% substitution via references and additionalImports for external TS file imports.

```php
new TypeScriptRaw('Record<string, never>')
```

```php
new TypeScriptRaw('%User% | null', references: ['User' => UserData::class])
```

--------------------------------

### Use references parameter with %placeholder% syntax

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/typing-properties.md

Use the `references` parameter in `#[LiteralTypeScriptType]` to reference other transformed PHP types. Each `%Name%` placeholder is replaced with the resolved type name, integrating into the full reference graph with import generation, alias resolution, and missing reference tracking.

```php
use Spatie\TypeScriptTransformer\Attributes\LiteralTypeScriptType;

class Types
{
    #[LiteralTypeScriptType(
        'Record<string, %User%> | %Post%[]',
        references: [
            'User' => UserData::class,
            'Post' => PostData::class,
        ]
    )]
    public array $property;
}
```

--------------------------------

### TypeScriptInterface constructor

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/reference.md

Creates a TypeScriptInterface node with properties and method signatures. The TypeScript output is `interface User { name: string; greet(): void; }`.

```php
new TypeScriptInterface('User', [new TypeScriptProperty('name', new TypeScriptString())], [new TypeScriptMethodSignature('greet', [], new TypeScriptVoid())])
```

--------------------------------

### Using the controller namespace for response types

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

Shows how to use the generated controller namespace to type the response from a fetch call. The response is cast to `ShowDashboardController.Response`.

```ts
const response = await fetch(url);
const data = await response.json() as ShowDashboardController.Response;
```

--------------------------------

### Register FixArrayLikeStructuresClassPropertyProcessor with replaceArrayLikeClass

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/transformers/class-transformer.md

Shows how to register the processor and add a custom array-like class (e.g., Illuminate\Support\Collection) to be converted. By default, it replaces Array<K, V> generics; pass replaceArrays: false to disable.

```php
use Spatie\TypeScriptTransformer\ClassPropertyProcessors\FixArrayLikeStructuresClassPropertyProcessor;

protected function classPropertyProcessors(): array
{
    return [
        new FixArrayLikeStructuresClassPropertyProcessor()
            ->replaceArrayLikeClass(
                Illuminate\Support\Collection::class,
            ),
    ];
}
```

--------------------------------

### WatchingTransformedProvider

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/watch-mode/watch-events.md

Interface for providers that need to watch directories for file changes and handle watch events to update the transformed collection.

```APIDOC
## WatchingTransformedProvider

### Description
Providers can implement this interface to watch directories for file changes and handle watch events to update the transformed collection.

### Methods

#### directoriesToWatch
Returns an array of directories the provider wants to watch for changes.

**Signature:** `public function directoriesToWatch(): array`

**Returns:** `array` - Array of directory paths.

#### handleWatchEvent
Called when a change is detected in one of the watched directories. Should return `null` or `WatchEventResult::continue()` when everything went well, or `WatchEventResult::completeRefresh()` when a complete application refresh is needed.

**Signature:** `public function handleWatchEvent(WatchEvent $watchEvent, TransformedCollection $transformedCollection): ?WatchEventResult`

**Parameters:**
- **$watchEvent** (WatchEvent) - The watch event that occurred.
- **$transformedCollection** (TransformedCollection) - The current collection of transformed objects.

**Returns:** `?WatchEventResult` - Null or a WatchEventResult indicating whether to continue or refresh.

### Watch Event Types
- `FileCreatedWatchEvent`: A file was created
- `FileUpdatedWatchEvent`: A file was updated
- `FileDeletedWatchEvent`: A file was deleted
- `DirectoryDeletedWatchEvent`: A directory was deleted

All events extend `WatchEvent` and contain the path of the changed file or directory.

### Example
```php
use Spatie\TypeScriptTransformer\TransformedProviders\WatchingTransformedProvider;
use Spatie\TypeScriptTransformer\Data\WatchEventResult;
use Spatie\TypeScriptTransformer\Events\SummarizedWatchEvent;

class CustomWatchableProvider implements WatchingTransformedProvider, TransformedProvider
{
    public function directoriesToWatch(): array
    {
        return [__DIR__.'/models'];
    }

    public function handleWatchEvent(WatchEvent $watchEvent, TransformedCollection $transformedCollection): ?WatchEventResult
    {
        if(! $watchEvent instanceof SummarizedWatchEvent){
            return null;
        }

        // Handle changes to the TransformedCollection
    }
}
```
```

--------------------------------

### Controller method with Data object parameter for request type

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

Shows a PHP controller method with a `StorePostData` parameter, which is used to detect the request type. The first Data object parameter becomes the `Request` type.

```php
public function store(StorePostData $data): PostData
{
    // ...
}
```

--------------------------------

### Generate relative URL with route helper

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/routes.md

Pass false as the third parameter to generate relative URLs instead of absolute ones.

```ts
const indexUrl = route('users.index', {}, false);
// /users
```

--------------------------------

### TransformedProvider interface

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/providers/getting-started.md

Defines the TransformedProvider interface that custom providers must implement. The provide method should return an array of Transformed objects.

```php
namespace Spatie\TypeScriptTransformer\TransformedProviders;

interface TransformedProvider
{
    /**
     * @return array<Transformed>
     */
    public function provide(): array;
}
```

--------------------------------

### Generated TypeScript for PostsController index action

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/laravel/controllers.md

Shows how the generated TypeScript object is used. The `index` function returns an object with `url` and `method` properties. The comment shows the expected output.

```ts
import { PostsController } from './controllers';

const { url, method } = PostsController.index();
// { url: '/posts', method: 'get' }
```

--------------------------------

### Create TypeScriptParameter node

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/reference.md

Creates a TypeScript parameter node with a name, type, and optional flag.

```php
new TypeScriptParameter('name', new TypeScriptString(), isOptional: true)
```

--------------------------------

### Configure GlobalNamespaceWriter

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/first-run.md

Configures the writer to use GlobalNamespaceWriter, which writes all types to a single TypeScript file with namespaces.

```php
$config->writer(new GlobalNamespaceWriter());
```

--------------------------------

### Register provider in config

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/providers/getting-started.md

Registers the custom provider in the configuration.

```php
$config->provider(new AddLaravelCollectionProvider());
```

--------------------------------

### Register a transformer with the configuration

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/getting-started/first-run.md

Registers a transformer class with the configuration. This is done within a TypeScript CLI command or the TypeScriptTransformerServiceProvider for Laravel.

```php
$config->transformer(AttributedClassTransformer::class);
```

--------------------------------

### TransformedProviderActions

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/providers/helpers.md

This snippet lists the actions available on the TransformedProviderActions object.

```APIDOC
## [TransformedProviderActions] [TransformedProviderActions]

### Description
The `TransformedProviderActions` object provides actions for loading PHP class nodes, discovering types, transpiling PHPStan types, transpiling native PHP types, and parsing user-defined type strings.

### Method
Not applicable (object with actions)

### Endpoint
Not applicable (object with actions)

### Parameters
#### Actions
- **loadPhpClassNodeAction** - Load a `PhpClassNode` from a file path.
- **discoverTypesAction** - Discover PHP classes in directories.
- **transpilePhpStanTypeToTypeScriptNodeAction** - Transpile PHPStan doc types to TypeScript nodes.
- **transpilePhpTypeNodeToTypeScriptNodeAction** - Transpile native PHP types to TypeScript nodes.
- **parseUserDefinedTypeAction** - Parse a user-defined type string into a TypeScript node.

### Request Example
Not applicable (object with actions)

### Response
#### Success Response (200)
- **loadPhpClassNodeAction** - Action to load a `PhpClassNode` from a file path.
- **discoverTypesAction** - Action to discover PHP classes in directories.
- **transpilePhpStanTypeToTypeScriptNodeAction** - Action to transpile PHPStan doc types to TypeScript nodes.
- **transpilePhpTypeNodeToTypeScriptNodeAction** - Action to transpile native PHP types to TypeScript nodes.
- **parseUserDefinedTypeAction** - Action to parse a user-defined type string into a TypeScript node.

#### Response Example
Not applicable (object with actions)

### Error Handling
No error handling is documented for this object.
```

--------------------------------

### TypeScriptIndexSignature constructor

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/reference.md

Creates a TypeScriptIndexSignature node for index signatures like `[key: string]`.

```php
new TypeScriptIndexSignature(new TypeScriptString(), 'key')
```

--------------------------------

### Create a TypeScript alias node in PHP

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/introduction.md

Creates a TypeScriptAlias node representing a User object with id, name, and address properties. The address property is a union of string and null.

```php
use Spatie\TypeScriptTransformer\TypeScriptNodes;

new TypeScriptAlias(
    new TypeScriptIdentifier('User'),
    new TypeScriptObject([
        new TypeScriptProperty('id', new TypeScriptNumber()),
        new TypeScriptProperty('name', new TypeScriptString()),
        new TypeScriptProperty('address', new TypeScriptUnion([
            new TypeScriptString(),
            new TypeScriptNull(),
        ])),
    ]),
);
```

--------------------------------

### TypeScriptCallable - (...args: any[]) => any and (x: string) => void

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/reference.md

Creates callable type nodes, either with default parameters or custom function types.

```php
new TypeScriptCallable() // (...args: any[]) => any
new TypeScriptCallable([new TypeScriptParameter('x', new TypeScriptString())], new TypeScriptVoid()) // (x: string) => void
```

--------------------------------

### TypeScriptIndexedAccess - User["name"]

Source: https://github.com/spatie/typescript-transformer/blob/main/docs/typescript-nodes/reference.md

Creates an indexed access type node that outputs `User["name"]`.

```php
new TypeScriptIndexedAccess(new TypeScriptIdentifier('User'), [new TypeScriptLiteral('name')])
```
Tokens:
Raw