Skip to content

Secret ​

Type, in @jr2/orchestrator/src/http-effect.ts. The signature of an export, or a type that it names, names this type. The Authoring surface page lists each export. This type is not an export of @jr2/orchestrator, so a workflow module does not import it by name.

ts
type Secret = { readonly secret: string; readonly path: { readonly secret: string; readonly path: true } };

What secret("name") gives: an Effect secret, by its name in the secrets list of jr2.config.ts. Put it in an Effect's auth, a header, a text or a command's env. Its .path is the path of a file that holds the value. The value stays in the Effector, so the Machine and the Agent never see it.

Fields

  • secret: string

  • path: object

    • secret: string
    • path: true

The docs of Kit version 0.5.1. Each page is also at its .md URL.