rename

Rename an existing reference.

This method works for both direct and symbolic references.

Signature

class Reference {
  rename(newName: string, options?: RenameReferenceOptions): Reference;
}

Parameters

• newNamerequired · string
  

  Name to rename an existing reference.

• optionsnull | RenameReferenceOptions
  

  Options to rename an existing reference.

  • forceboolean
    

    If the force flag is not enabled, and there's already a reference with the given name, the renaming will fail.

  • logMessagestring
    

Returns

• Reference
  

  Renamed reference.