Utils.Function.is_identifier

@decentm/concourse-ts / Utils / is_identifier

Function: is_identifier()

is_identifier<IdentifierType>(input): input is IdentifierType

Defined in: utils/identifier/index.ts:43

Returns if the input is a valid Identifier, using the compiler's validator.

https://concourse-ci.org/docs/config-basics/#identifier-schema

Example:

const name = 'my-name'
   // ^? string

new Job(name) // Compilation error

if (!is_identifier(name)) {
  return
}

new Job(name) // No error
     // ^? Identifier

get_identifier

Identifier

Type Parameters

• IdentifierType extends Identifier = Identifier

Parameters

input

unknown

The potential Identifier to check

Returns

input is IdentifierType

Type guard for valid identifiers, using branded types.