Onepassword Local Client

Class Hierarchy

Methods

• addAccount
• getAccounts
• getAccountCredentials
• login

Methods

constructor

▸ constructor(fileInterface: [FileInterface], path: string, type?: [SourceType]): Promise‹boolean›

Parameters:

Name	Type
fileInterface	[FileInterface]
path	string
type	[SourceType]

Returns: void

---

addAccount

▸ addAccount(entry: [RawEntry]): Promise‹boolean›

Parameters:

Name	Type
entry	[RawEntry]

Returns: Promise‹boolean›

---

getAccounts

▸ getAccounts(): Promise‹[Entry]

Returns: Promise

---

getAccountCredentials

▸ getAccountCredentials(): Promise‹[EntryCredentials]

Returns: Promise

---

login

▸ login(password: string): Promise‹void›

Parameters:

Name	Type
password	string

Returns: Promise‹void›

Type aliases

FileInterface

Ƭ FileInterface:

{
    readFile: (path: string) => Promise<string>;
    writeFile: (path: string, data: string) => Promise<void>;
    findFile: (path: string) => Promise<boolean>;
    createFile: (path: string) => Promise<void>;
    deleteFile: (path: string) => Promise<void>;
}

---

SourceType

enum SourceType {
  SQLITE,
  OPVAULT
}

Default: SQLITE

---

RawEntry

Ƭ RawEntry: Record‹RawEntryFields, string›

---

RawEntryFields

Ƭ RawEntryFields: _"name" | "url" | "type" | "username" | "password" | "otp"

---

Entry

Ƭ Entry: Record‹EntryFields, string›

---

EntryFields

Ƭ EntryFields: _"name" | "url" | "type"

---

EntryCredentials

Ƭ EntryCredentials: Record‹EntryCredentialsFields, string›

---

EntryCredentialsFields

Ƭ EntryCredentialsFields: _"username" | "password" | "otp";

---