Skip to content

IdParamVerifyOptions

IdParamVerifyOptions = IdParamOptions & object

Defined in: src/adapters/nestjs.ts:46

Extends IdParamOptions with opt-in HMAC tag verification. Only accepted when the codec satisfies IdVerifiableCodec (the Signed Timestamp codec or Wrapped key codec). When verify is truthy, ParseIdPipe.transform returns a Promise that awaits codec.safeVerify(raw); a tag mismatch is treated as a "malformed" failure. NestJS supports async pipes natively — the resolved Id<Brand> reaches the handler.

optional verify?: boolean

When truthy, awaits codec.safeVerify(raw) after structural parse and treats a tag failure as "malformed". Accepts any boolean so computed flags ({ verify: cfg.verifyIds }) compile without casting.