nitric library
Classes
- Api
- An API resource.
- ApiOptions
- BlobEventContext
- The context of a Blob event request/response.
- BlobEventRequest
- Represents the blob event request
- BlobEventResponse
- Represents the blob event response.
- BucketResource
- FileEventContext
- The context of a Blob event request/response.
- FileEventRequest
- Represents the blob event request.
- HttpContext
- The context of a HTTP request/response triggered by a request to an API.
- HttpRequest
- Represents a HTTP request.
- HttpResponse
- Represents a HTTP response.
- IntervalContext
- The context for a scheduled interval request/response.
- IntervalRequest
- Represents a scheduled request.
- IntervalResponse
- Represents a response to a scheduled request.
- JobContext
- The context for a topic message for a subscription.
- JobRequest
- Represents a request received by a subscription to a topic.
- JobResource
- JobResourceRequirements
- JobResponse
- Represents a response to a topic subscription request.
- KeyValueStoreResource
- MessageContext
- The context for a topic message for a subscription.
- MessageRequest
- Represents a request received by a subscription to a topic.
- MessageResponse
- Represents a response to a topic subscription request.
- Nitric
- OidcOptions
- OidcSecurityDefinition
- QueueResource
- Resource
- A representation of a resource that can be registered with the Nitric server.
- Route
- Represents a single route on an API.
- Schedule
- SecretResource
-
SecureResource<
T extends Enum> - A resource that requires permissions to access it.
- Topic
-
TriggerContext<
Req extends TriggerRequest, Resp extends TriggerResponse> - Base context to wrap request/response objects from the server.
- TriggerRequest
- The trigger request.
- TriggerResponse
- The trigger response.
- Websocket
- WebsocketContext
- Base context for a websocket based request/response.
- WebsocketRequest
- Represents a websocket request.
- WebsocketResponse
- Represents a response from a websocket request.
Enums
Functions
-
attachOidc(
String apiName, OidcOptions options) → Future< void> -
composeMiddleware<
T extends TriggerContext< (TriggerRequest, TriggerResponse> >List< Handler< handlers, T converter(T ctx, Handler<T> >T> next)) → Handler<T>
Typedefs
-
BlobEventHandler
= Handler<
BlobEventContext> -
FileEventHandler
= Handler<
FileEventContext> -
Handler<
T extends TriggerContext< TriggerRequest, TriggerResponse> > = Future<T> Function(T ctx) -
HttpHandler
= Handler<
HttpContext> -
IntervalHandler
= Handler<
IntervalContext> -
JobHandler
= Handler<
JobContext> -
MessageHandler
= Handler<
MessageContext> -
SecurityOption
= OidcOptions Function(List<
String> scopes) -
WebsocketHandler
= Handler<
WebsocketContext>