|
| 1 | +<!-- |
| 2 | +This file was generated by Spark. Do not edit it by hand. |
| 3 | +--> |
| 4 | +# AshTypescript.Rpc |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +## typescript_rpc |
| 9 | +Define available RPC-actions for resources in this domain. |
| 10 | + |
| 11 | +### Nested DSLs |
| 12 | + * [resource](#typescript_rpc-resource) |
| 13 | + * rpc_action |
| 14 | + * typed_query |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +### typescript_rpc.resource |
| 21 | +```elixir |
| 22 | +resource resource |
| 23 | +``` |
| 24 | + |
| 25 | + |
| 26 | +Define available RPC-actions for a resource |
| 27 | + |
| 28 | +### Nested DSLs |
| 29 | + * [rpc_action](#typescript_rpc-resource-rpc_action) |
| 30 | + * [typed_query](#typescript_rpc-resource-typed_query) |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | + |
| 35 | +### Arguments |
| 36 | + |
| 37 | +| Name | Type | Default | Docs | |
| 38 | +|------|------|---------|------| |
| 39 | +| [`resource`](#typescript_rpc-resource-resource){: #typescript_rpc-resource-resource } | `module` | | The resource being configured | |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | +### typescript_rpc.resource.rpc_action |
| 44 | +```elixir |
| 45 | +rpc_action name, action |
| 46 | +``` |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | + |
| 55 | +### Arguments |
| 56 | + |
| 57 | +| Name | Type | Default | Docs | |
| 58 | +|------|------|---------|------| |
| 59 | +| [`name`](#typescript_rpc-resource-rpc_action-name){: #typescript_rpc-resource-rpc_action-name } | `atom` | | The name of the RPC-action | |
| 60 | +| [`action`](#typescript_rpc-resource-rpc_action-action){: #typescript_rpc-resource-rpc_action-action } | `atom` | | The resource action to expose | |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | +### Introspection |
| 68 | + |
| 69 | +Target: `AshTypescript.Rpc.RpcAction` |
| 70 | + |
| 71 | +### typescript_rpc.resource.typed_query |
| 72 | +```elixir |
| 73 | +typed_query name, action |
| 74 | +``` |
| 75 | + |
| 76 | + |
| 77 | + |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | +### Arguments |
| 84 | + |
| 85 | +| Name | Type | Default | Docs | |
| 86 | +|------|------|---------|------| |
| 87 | +| [`name`](#typescript_rpc-resource-typed_query-name){: #typescript_rpc-resource-typed_query-name } | `atom` | | The name of the RPC-action | |
| 88 | +| [`action`](#typescript_rpc-resource-typed_query-action){: #typescript_rpc-resource-typed_query-action } | `atom` | | The read action on the resource to query | |
| 89 | +### Options |
| 90 | + |
| 91 | +| Name | Type | Default | Docs | |
| 92 | +|------|------|---------|------| |
| 93 | +| [`ts_result_type_name`](#typescript_rpc-resource-typed_query-ts_result_type_name){: #typescript_rpc-resource-typed_query-ts_result_type_name } | `String.t` | | The name of the TypeScript type for the query result | |
| 94 | +| [`ts_fields_const_name`](#typescript_rpc-resource-typed_query-ts_fields_const_name){: #typescript_rpc-resource-typed_query-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 | |
| 95 | +| [`fields`](#typescript_rpc-resource-typed_query-fields){: #typescript_rpc-resource-typed_query-fields } | `list(any)` | | The fields to query | |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | + |
| 100 | + |
| 101 | +### Introspection |
| 102 | + |
| 103 | +Target: `AshTypescript.Rpc.TypedQuery` |
| 104 | + |
| 105 | + |
| 106 | + |
| 107 | + |
| 108 | +### Introspection |
| 109 | + |
| 110 | +Target: `AshTypescript.Rpc.Resource` |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | + |
| 115 | + |
| 116 | +<style type="text/css">.spark-required::after { content: "*"; color: red !important; }</style> |
0 commit comments