SAF Documentation

Appearance

@saflib/node

Interface: SafContextWithAuth ​

Convenience type for when the context needs to have auth.

Extends ​

Properties ​

auth ​

auth: Auth

If the request is backed by an authenticated user, this will be set. More info should be gotten directly from the auth service.

Overrides ​

SafContext.auth

operationName ​

operationName: string

Format: "{method_name}" e.g. "GetUser", such as operationId in OpenAPI, rpc name in gRPC, job name in cron, or command name in CLI.

Inherited from ​

SafContext.operationName

requestId? ​

optional requestId: string

Format: "{uuid}" Generated by request instantiators server-side, so things like reverse proxies, async job services, and http servers which are directly accessible by clients. Generally, grpc and http servers receive a request ID and should use it to correlate requests across processes.

Inherited from ​

SafContext.requestId

serviceName ​

serviceName: string

Format: "{service}" e.g. "auth", "payment", "logging", or the name of a product. The name should match the docker service and npm package name (not including the org).

Inherited from ​

SafContext.serviceName

subsystemName ​

subsystemName: SubsystemName

Format: "{subsystem}"

Basically, a single server or long-running "process".

Inherited from ​

SafContext.subsystemName