AshTypescript.Rpc
View Sourcetypescript_rpc
Define available RPC-actions for resources in this domain.
Nested DSLs
- resource
- rpc_action
- typed_query
typescript_rpc.resource
resource resourceDefine available RPC-actions for a resource
Nested DSLs
Arguments
| Name | Type | Default | Docs |
|---|---|---|---|
resource | module | The resource being configured |
typescript_rpc.resource.rpc_action
rpc_action name, actionDefine an RPC action that exposes a resource action to TypeScript clients.
Metadata fields: Action metadata can be exposed via show_metadata option.
Set to nil (default) to expose all metadata fields, false or [] to disable,
or provide a list of atoms to expose specific fields.
Metadata field naming: Use metadata_field_names to map invalid metadata field names
(e.g., field_1, is_valid?) to valid TypeScript identifiers.
Example: metadata_field_names [field_1: :field1, is_valid?: :isValid]
Arguments
| Name | Type | Default | Docs |
|---|---|---|---|
name | atom | The name of the RPC-action | |
action | atom | The resource action to expose |
Options
| Name | Type | Default | Docs |
|---|---|---|---|
show_metadata | nil | boolean | list(atom) | Which metadata fields to expose (nil=all, false/[]=none, list=specific fields) | |
metadata_field_names | list({atom, atom}) | [] | Map metadata field names to valid TypeScript identifiers |
Introspection
Target: AshTypescript.Rpc.RpcAction
typescript_rpc.resource.typed_query
typed_query name, actionArguments
| Name | Type | Default | Docs |
|---|---|---|---|
name | atom | The name of the RPC-action | |
action | atom | The read action on the resource to query |
Options
| Name | Type | Default | Docs |
|---|---|---|---|
ts_result_type_name | String.t | The name of the TypeScript type for the query result | |
ts_fields_const_name | String.t | The name of the constant for the fields, that can be reused by the client to re-run the query | |
fields | list(any) | The fields to query |
Introspection
Target: AshTypescript.Rpc.TypedQuery
Introspection
Target: AshTypescript.Rpc.Resource