Class default

The credentials as they stood before a save, and how to put them back.

Index

Methods

take restoreAfter discard

Methods

`Static`take

take(fileSystem: IFileSystem, credPath: string): Procedure<default>
Copies the current credentials aside. Only ENOENT means there is nothing to copy: a symlink, a directory or an unreadable file there is not "nothing", and the save must stop rather than replace it.
Parameters
- fileSystem: IFileSystem
  Filesystem the credentials live on.
- credPath: string
  Absolute path to credentials.json.
Returns Procedure<default>
The backup, or why the save must not go ahead.
- Defined in Config/CredentialsBackup.ts:61

restoreAfter

restoreAfter(failure: IProcedureFailure): IProcedureFailure
Puts the credentials back as they were before the save: the copy is renamed over them, or on a first save the new file is removed. A copy that cannot be put back is kept, because it is the only one left.
Parameters
- failure: IProcedureFailure
  What stopped the save.
Returns IProcedureFailure
The failure, naming the restore's own failure when there is one.
- Defined in Config/CredentialsBackup.ts:114

discard

discard(): boolean
Deletes the copy once it is no longer needed, best-effort: a copy left behind is swept like any staged file.

Returns boolean
Whether no copy is left.
- Defined in Config/CredentialsBackup.ts:127