Class ProfileProvider<P> Abstract

Type Parameters

P extends Profile

Hierarchy

ProfileProvider
- ConnectableProfileProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ProfileProvider<P>(): ProfileProvider<P>

Type Parameters
- P extends Profile
Returns ProfileProvider<P>

Properties

configDefaults

configDefaults: Pick<Profile, "options">

id

id: string

name

name: string

Optional settingsComponent

settingsComponent?: (new (...args: any[]) => ProfileSettingsComponent<P, ProfileProvider<P>>)

Type declaration

- new (...args: any[]): ProfileSettingsComponent<P, ProfileProvider<P>>
- Parameters
  - Rest ...args: any[]
  Returns ProfileSettingsComponent<P, ProfileProvider<P>>

Methods

deleteProfile

deleteProfile(profile: P): void

- Defined in tabby-core/src/api/profileProvider.ts:75
Parameters
- profile: P
Returns void

Abstract getBuiltinProfiles

getBuiltinProfiles(): Promise<PartialProfile<P>[]>

- Defined in tabby-core/src/api/profileProvider.ts:65
Returns Promise<PartialProfile<P>[]>

Abstract getDescription

getDescription(profile: PartialProfile<P>): string

- Defined in tabby-core/src/api/profileProvider.ts:73
Parameters
- profile: PartialProfile<P>
Returns string

Abstract getNewTabParameters

getNewTabParameters(profile: P): Promise<NewTabParameters<BaseTabComponent>>

- Defined in tabby-core/src/api/profileProvider.ts:67
Parameters
- profile: P
Returns Promise<NewTabParameters<BaseTabComponent>>

getSuggestedName

getSuggestedName(profile: PartialProfile<P>): null | string

- Defined in tabby-core/src/api/profileProvider.ts:69
Parameters
- profile: PartialProfile<P>
Returns null | string

Generated using TypeDoc