GitHub

API reference for Mutate.

class Mutate[P, Q, B, H, A, E]

Calls a mutation with the parts its endpoint declares (AtomHttpApiClient.mutate).

Functions

__init__

__init__(mutation) -> None
ParameterTypeDescription
mutationWritable[AsyncResult[A, E], Any]
def __init__(self, mutation: Writable[AsyncResult[A, E], Any]) -> None:
    self._mutation = mutation

__call__

__call__(*, params=None, query=None, payload=None, headers=None, sse_options=None, reactivity_keys=None) -> Effect[A, E, AtomRegistry]
ParameterTypeDescription
paramsP | None = None
queryQ | None = None
payloadB | None = None
headersH | None = None
sse_optionsSseOptions | None = None
reactivity_keysKeys | None = None

Returns Effect[A, E, AtomRegistry]

def __call__(
    self,
    *,
    params: P | None = None,
    query: Q | None = None,
    payload: B | None = None,
    headers: H | None = None,
    sse_options: SseOptions | None = None,
    reactivity_keys: Keys | None = None,
) -> Effect[A, E, AtomRegistry]:
    given = {
        "params": params,
        "query": query,
        "payload": payload,
        "headers": headers,
        "sse_options": sse_options,
        "reactivity_keys": reactivity_keys,
    }
    request = {name: value for name, value in given.items() if value is not None}
    return set_atom(self._mutation, request).and_then(
        get_result(self._mutation, suspend_on_waiting=True)
    )