isValidReferenceName

Ensure the reference name is well-formed.

Validation is performed as if ReferenceFormat.AllowOnelevel was given to normalizeReferenceName No normalization is performed, however.

Signature

function isValidReferenceName(refname: string): boolean;

Parameters

• refnamerequired · string
  

  Reference name to check if it is valid.

Returns

• boolean
  

  Returns true if reference name is valid.

Examples

import { isValidReferenceName } from 'es-git';

console.assert(isValidReferenceName("HEAD"));
console.assert(isValidReferenceName("refs/heads/main"));

// But:
console.assert(!isValidReferenceName("main"));
console.assert(!isValidReferenceName("refs/heads/*"));
console.assert(!isValidReferenceName("foo//bar"));