Class TabRecoveryProvider<T> Abstract

Extend to enable recovery for your custom tab. This works in conjunction with [[getRecoveryToken()]]

Tabby will try to find any TabRecoveryProvider that is able to process the recovery token previously returned by getRecoveryToken.

Recommended token format:

{
  type: 'my-tab-type',
  foo: 'bar',
}

Type Parameters

T extends BaseTabComponent

Hierarchy

TabRecoveryProvider

Index

Constructors

constructor

Methods

Constructors

constructor

new TabRecoveryProvider<T>(): TabRecoveryProvider<T>

Type Parameters
- T extends BaseTabComponent<T>
Returns TabRecoveryProvider<T>

Methods

Abstract applicableTo

applicableTo(recoveryToken: RecoveryToken): Promise<boolean>

- Defined in tabby-core/src/api/tabRecovery.ts:33
Parameters
- recoveryToken: RecoveryToken
  
  a recovery token found in the saved tabs list
Returns Promise<boolean>
[[boolean]] whether this TabRecoveryProvider can recover a tab from this token

Abstract recover

recover(recoveryToken: RecoveryToken): Promise<NewTabParameters<T>>

- Defined in tabby-core/src/api/tabRecovery.ts:40
Parameters
- recoveryToken: RecoveryToken
  
  a recovery token found in the saved tabs list
Returns Promise<NewTabParameters<T>>
NewTabParameters descriptor containing tab type and component inputs or null if this token is from a different tab type or is not supported

Generated using TypeDoc