Variable rotatableSecretShape`Const`

rotatableSecretShape: ShapeDefinition<
{ current: string; legacy: ShapeOptional<string> },
false,
> = ...

The shape definition for built-in handling of secret rotation. Use this shape in a secret definition's shape property (when using defineSecrets).

Example

Use as the whole secret shape:

import {defineSecrets, rotatableSecretShape} from 'updating-secrets';

defineSecrets({
    mySecret: {
        description: '',
        whereToFind: '',
        shape: rotatableSecretShape,
    },
});

Use as a nested secret shape:

import {defineSecrets, rotatableSecretShape} from 'updating-secrets';

defineSecrets({
    mySecret: {
        description: '',
        whereToFind: '',
        shape: {
            a: rotatableSecretShape,
            b: '',
        },
    },
});