@saflib/node

---

Interface: SafContextWithAuth

Convenience type for when the context needs to have auth.

Extends

• SafContext

Properties

acceptLanguage?

optional acceptLanguage: string

HTTP Accept-Language header when present.

Inherited from

SafContext.acceptLanguage

---

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

---

clientIp?

optional clientIp: string

Best-effort client IP for the inbound request (e.g. first X-Forwarded-For hop, else Express req.ip, else socket).

Inherited from

SafContext.clientIp

---

host?

optional host: string

HTTP Host header (or equivalent) for the inbound request, when known (e.g. Express). Used for analytics and routing diagnostics.

Inherited from

SafContext.host

---

jobId?

optional jobId: string

When this request is a job delivery, the delivering job's id (from assertion claims). Chained enqueue() calls use it as parentJobId.

Inherited from

SafContext.jobId

---

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

---

origin?

optional origin: string

HTTP Origin header when the client sends it (e.g. browsers, CORS).

Inherited from

SafContext.origin

---

originalRequestId?

optional originalRequestId: string

Lineage root of a background chain. Set from assertion claims when present; consumers fall back to requestId when absent.

Inherited from

SafContext.originalRequestId

---

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

---

userAgent?

optional userAgent: string

HTTP User-Agent header when present.

Inherited from

SafContext.userAgent