XrpcServer (FSharp.ATProto) | FSharp.ATProto

FSharp.ATProto

XrpcServer Module

Namespace: FSharp.ATProto.XrpcServer
Assembly: FSharp.ATProto.XrpcServer.dll

XRPC server builder and configuration.

Functions and values

Function or value	Description
`addEndpoint ep config` Full Usage: `addEndpoint ep config` Parameters: ep : `XrpcEndpoint` config : `XrpcServerConfig` Returns: `XrpcServerConfig`	Add an endpoint to the server config. ep : `XrpcEndpoint` config : `XrpcServerConfig` Returns: `XrpcServerConfig`
`configure config` Full Usage: `configure config` Parameters: config : `XrpcServerConfig` Returns: `WebApplication`	Build and configure a WebApplication with all registered XRPC endpoints. config : `XrpcServerConfig` Returns: `WebApplication`
`configureWithPort port config` Full Usage: `configureWithPort port config` Parameters: port : `int` config : `XrpcServerConfig` Returns: `WebApplication`	Configure and set the server to listen on the given port. port : `int` config : `XrpcServerConfig` Returns: `WebApplication`
`endpoint nsid method handler` Full Usage: `endpoint nsid method handler` Parameters: nsid : `Nsid` method : `XrpcMethod` handler : `HttpContext -> Task<IResult>` Returns: `XrpcEndpoint`	Create an XRPC endpoint definition. nsid : `Nsid` method : `XrpcMethod` handler : `HttpContext -> Task<IResult>` Returns: `XrpcEndpoint`
`healthCheck () _ctx` Full Usage: `healthCheck () _ctx` Parameters: () : `unit` _ctx : `HttpContext` Returns: `Task<IResult>`	Health check handler returning server status. () : `unit` _ctx : `HttpContext` Returns: `Task<IResult>`
`withAuth ep` Full Usage: `withAuth ep` Parameters: ep : `XrpcEndpoint` Returns: `XrpcEndpoint`	Mark an endpoint as requiring authentication. ep : `XrpcEndpoint` Returns: `XrpcEndpoint`
`withGlobalRateLimit rateLimit config` Full Usage: `withGlobalRateLimit rateLimit config` Parameters: rateLimit : `RateLimitConfig` config : `XrpcServerConfig` Returns: `XrpcServerConfig`	Set a global rate limit for endpoints without per-endpoint limits. rateLimit : `RateLimitConfig` config : `XrpcServerConfig` Returns: `XrpcServerConfig`
`withJsonOptions options config` Full Usage: `withJsonOptions options config` Parameters: options : `JsonSerializerOptions` config : `XrpcServerConfig` Returns: `XrpcServerConfig`	Set custom JSON options. options : `JsonSerializerOptions` config : `XrpcServerConfig` Returns: `XrpcServerConfig`
`withRateLimit config ep` Full Usage: `withRateLimit config ep` Parameters: config : `RateLimitConfig` ep : `XrpcEndpoint` Returns: `XrpcEndpoint`	Set a rate limit on an endpoint. config : `RateLimitConfig` ep : `XrpcEndpoint` Returns: `XrpcEndpoint`
`withTokenVerifier verifyToken config` Full Usage: `withTokenVerifier verifyToken config` Parameters: verifyToken : `string -> Task<Result<ClaimsPrincipal, string>>` config : `XrpcServerConfig` Returns: `XrpcServerConfig`	Set the token verification function. verifyToken : `string -> Task<Result<ClaimsPrincipal, string>>` config : `XrpcServerConfig` Returns: `XrpcServerConfig`