StringUtility

String helpers for module and resource authors: hashing values into stable ids, fitting names into a provider's length limit, and making names safe for terraform.

@group

Utilities/String

Index

Constructors

• constructor

Methods

• boundedName
• deterministicHash
• sanitizeForEnvironmentVariable
• sanitizeForIdentifier

Constructors

constructor

• StringUtility(): StringUtility

• Returns StringUtility

Methods

staticboundedName

• boundedName(name: string, maxLength: number): string

• Shortens a name to at most maxLength characters, replacing what is cut with a digest of the whole name. Two names that differ anywhere still differ after shortening, and the same name always shortens the same way. A name already within the limit is returned as it is.

  Use it where a provider limits a name that is built by joining others, e.g. a distribution name and an origin id, so that cutting the tail alone could make two names collide.

  @example

  StringUtility.boundedName('my-distribution-with-a-very-long-origin-id', 20);
  // The first 11 characters, a dash and 8 hex characters: 20 in all.

  ---

  Parameters

  • name: string

  • maxLength: number

  Returns string

staticdeterministicHash

• deterministicHash(value: unknown): string

• Produces a 16-character hex hash of any value, with object keys sorted recursively, so the hash does not change when key insertion order does. Hash several parts as an array, deterministicHash([bucketName, accessPrefix]), which keeps ['ab', 'c'] and ['a', 'bc'] apart. Take a prefix of it where a shorter id is enough.

  ---

  Parameters

  • value: unknown

  Returns string

staticsanitizeForEnvironmentVariable

• sanitizeForEnvironmentVariable(value: string): string

• Replaces every character that is not a letter, digit, or underscore with an underscore. Suitable for names that travel through environment variables (e.g. terraform variables, which terragrunt passes as TF_VAR_<name>), where dashes are not allowed.

  ---

  Parameters

  • value: string

  Returns string

staticsanitizeForIdentifier

• sanitizeForIdentifier(value: string): string

• Replaces every character that is not a letter, digit, underscore, or dash with an underscore. Suitable for terraform identifiers (resource names, output names), which allow dashes.

  ---

  Parameters

  • value: string

  Returns string