Config.Config<Redacted<string>>Effect Config for the local assume token (HYPERLINK_ASSUME_TOKEN) — optional
injection sugar; not the wire protocol.
configConfig
Source src/internal/nodeAssumeClient.ts:311 lines
export const const assumeTokenConfig: Config.Config<
Redacted<string>
>
const assumeTokenConfig: {
parse: (provider: ConfigProvider.ConfigProvider, pathPrefix?: Path) => Effect.Effect<T, ConfigError>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
Effect
Config
for the local assume token (HYPERLINK_ASSUME_TOKEN) — optional
injection sugar; not the wire protocol.
assumeTokenConfig = import ConfigConfig.function redacted(
name?: string
): Config.Config<Redacted<string>>
Creates a config for a redacted string value. The parsed result is wrapped
in a Redacted container that hides the value from logs and toString.
When to use
Use to read secret string settings that should not be exposed in logs or
string output.
Details
Shortcut for Config.schema(Schema.Redacted(Schema.String), name).
Example (Reading a secret)
import { Config, ConfigProvider, Effect } from "effect"
const program = Effect.gen(function*() {
const apiKey = yield* Config.redacted("API_KEY")
console.log(apiKey)
})
const provider = ConfigProvider.fromEnv({
env: {
API_KEY: "sk-1234567890abcdef"
}
})
Effect.runSync(
program.pipe(Effect.provideService(ConfigProvider.ConfigProvider, provider))
)
// Output: <redacted>
redacted(const ASSUME_TOKEN_ENV: "HYPERLINK_ASSUME_TOKEN"Default env / Config name for local Node token injection sugar.
ASSUME_TOKEN_ENV);