Packages
ash_typescript
0.11.1
0.17.3
0.17.2
0.17.1
0.17.0
0.16.0
0.15.3
0.15.2
retired
0.15.1
retired
0.15.0
0.14.4
0.14.3
0.14.2
0.14.1
0.14.0
retired
0.13.2
0.13.1
0.13.0
0.12.1
0.12.0
0.11.6
0.11.5
0.11.4
0.11.3
0.11.2
0.11.1
0.11.0
0.10.2
0.10.1
0.10.0
0.9.1
0.9.0
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.1
0.7.0
0.6.4
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.0
0.3.3
0.3.2
0.3.1
0.2.0
0.1.2
0.1.0
Generate type-safe TypeScript clients directly from your Ash resources and actions, ensuring end-to-end type safety between your backend and frontend.
Current section
Files
Jump to
Current section
Files
documentation/dsls/DSL-AshTypescript.Resource.md
<!--
This file was generated by Spark. Do not edit it by hand.
-->
# AshTypescript.Resource
Spark DSL extension for configuring TypeScript generation on Ash resources.
This extension allows resources to define TypeScript-specific settings,
such as custom type names for the generated TypeScript interfaces.
## typescript
Define TypeScript settings for this resource
### Options
| Name | Type | Default | Docs |
|------|------|---------|------|
| [`type_name`](#typescript-type_name){: #typescript-type_name .spark-required} | `String.t` | | The name of the TypeScript type for the resource |
| [`field_names`](#typescript-field_names){: #typescript-field_names } | `keyword` | `[]` | A keyword list mapping Elixir field names to TypeScript client names. Use strings for the client names - no additional formatting is applied. (e.g., [is_active?: "isActive", address_line_1: "addressLine1"]) |
| [`argument_names`](#typescript-argument_names){: #typescript-argument_names } | `keyword` | `[]` | A keyword list mapping Elixir argument names to TypeScript client names per action. Use strings for the client names - no additional formatting is applied. (e.g., [read_action: [is_active?: "isActive"]]) |
<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style>