Skip to main content

Function: isPlatformActor()

isPlatformActor(actor): actor is { kind: "platform"; roles: string[]; scopePath: "/"; subjectId: "00000000-0000-0000-0000-000000000000"; tenant: "platform" }

Defined in: packages/contracts/src/envelope.ts:85

Whether an actor is the platform actor.

Parameters​

actor​

{ kind: "tenant"; roles: string[]; scopePath: string; subjectId: string; tenant: string; } | { kind: "platform"; roles: string[]; scopePath: "/"; subjectId: "00000000-0000-0000-0000-000000000000"; tenant: "platform"; }

A validated actor.

Returns​

actor is { kind: "platform"; roles: string[]; scopePath: "/"; subjectId: "00000000-0000-0000-0000-000000000000"; tenant: "platform" }

true for the platform actor; narrows the type.