roadiz/dts-generator

Roadiz sub-package which generates Typescript interfaces skeleton based on your schema

v2.3.31 2024-10-26 17:31 UTC

Requires

• roadiz/nodetype-contracts: ~1.1.2
• symfony/http-foundation: 6.4.*

Requires (Dev)

• phpstan/phpstan: ^1.5.3
• squizlabs/php_codesniffer: ^3.5

MIT

• Ambroise Maupate

README

Roadiz sub-package which generates Typescript interface declaration skeleton based on your schema.

Usage

use RZ\Roadiz\Contracts\NodeType\NodeTypeInterface;
use RZ\Roadiz\Typescript\Declaration\DeclarationGeneratorFactory;
use RZ\Roadiz\Typescript\Declaration\Generators\DeclarationGenerator;
use Symfony\Component\HttpFoundation\ParameterBag;

/** @var ParameterBag<NodeTypeInterface> $nodeTypesBag */
$nodeTypesBag = $serviceContainer->get('nodeTypesBag');

$declarationFactory = new DeclarationGeneratorFactory($nodeTypesBag);
$declaration = new DeclarationGenerator($declarationFactory);

echo $declaration->getContents();

Contributing

Report issues and send Pull Requests in the main Roadiz repository