GitHub

Subscription

API reference for Subscription.

A subscription. On a group instance (a client) it is its SubscriptionMethod.

Functions

__init__

__init__(*, kind, name, document, template, variables, result, middlewares=()) -> None
ParameterTypeDescription
kindKind
namestr
documentstr
templateDocumentTemplate | None
variablesCodec[Any, Any, Any, Any]
resultCodec[Any, Any, Any, Any]
middlewarestuple[AnyMiddleware, ...] = ()

middleware

middleware[E2, R2, T](middleware) -> Subscription[V, A_co, ME_co | E2, MR_co | R2]

A copy with middleware added last; this one is unchanged.

ParameterTypeDescription
middlewareTagLike[Implementation[E2, R2], T]

Returns Subscription[V, A_co, ME_co | E2, MR_co | R2]

def middleware[E2, R2, T](
    self, middleware: TagLike[Implementation[E2, R2], T], /
) -> Subscription[V, A_co, ME_co | E2, MR_co | R2]:
    """A copy with ``middleware`` added last; this one is unchanged."""
    added: Any = middleware
    return replace(self, middlewares=(*self.middlewares, added))