AshTypescript.Rpc

View Source

typescript_rpc

Define available RPC-actions for resources in this domain.

Nested DSLs

typescript_rpc.resource

resource resource

Define available RPC-actions for a resource

Nested DSLs

Arguments

NameTypeDefaultDocs
resourcemoduleThe resource being configured

typescript_rpc.resource.rpc_action

rpc_action name, action

Arguments

NameTypeDefaultDocs
nameatomThe name of the RPC-action
actionatomThe resource action to expose

Introspection

Target: AshTypescript.Rpc.RpcAction

typescript_rpc.resource.typed_query

typed_query name, action

Arguments

NameTypeDefaultDocs
nameatomThe name of the RPC-action
actionatomThe read action on the resource to query

Options

NameTypeDefaultDocs
ts_result_type_nameString.tThe name of the TypeScript type for the query result
ts_fields_const_nameString.tThe name of the constant for the fields, that can be reused by the client to re-run the query
fieldslist(any)The fields to query

Introspection

Target: AshTypescript.Rpc.TypedQuery

Introspection

Target: AshTypescript.Rpc.Resource