Captain is currently in ALPHA. We are happy to get your feedback
Core API
Helpers Types

Module: helpers/types

Table of contents

Interfaces

Type Aliases

Type Aliases

KeysSettings

Ƭ KeysSettings: Record<string, string>

Defines a structure for storing key-value pairs, where both the key and the value are strings. This structure is particularly suited for storing sensitive information such as API keys, making it easy to retrieve them by their identifiers throughout the application.

The KeysSettings type is intended for use with the keysStore, providing a straightforward way to manage and access various configuration settings or secrets securely. Each record represents a unique identifier mapped to its corresponding value (e.g., an API key).

Defined in

src/electron/helpers/types.ts:286 (opens in a new tab)


Manifest

Ƭ Manifest: { [K in OS]?: Resource[] }

Describes the structure of a manifest that contains resources grouped by operating system. Each operating system can have a list of resources specific to it, allowing for flexible resource management across different platforms.

Defined in

src/electron/helpers/types.ts:358 (opens in a new tab)


OS

Ƭ OS: "windows" | "macos" | "linux"

Represents the supported operating systems.

Defined in

src/electron/helpers/types.ts:352 (opens in a new tab)


UserSettings

Ƭ UserSettings: UserPrimarySettings & UserSecondarySettings & UserTertiarySettings

Combines ass userStore settings into a single type for comprehensive user settings management.

Defined in

src/electron/helpers/types.ts:135 (opens in a new tab)