Zum Hauptinhalt springen

OnePassword

OnePassword wrapper class

Constructors​

Constructor​

new OnePassword(lastErrorPath?): OnePassword

Parameters​

lastErrorPath?​

string

Returns​

OnePassword

Methods​

getLastError()​

getLastError(): string

Return last error message

Returns​

string

itemCreate()​

itemCreate(assignments?, flags?, rawFlags?): OpTypedResult<OpItem>

Create an item Command: op item create [ - ] [ <assignment>... ] [flags]

Parameters​

assignments?​

Assignments

flags?​

CreateItemFlags

rawFlags?​

RawFlags

Returns​

OpTypedResult<OpItem>

itemGet()​

itemGet(itemIdentifier, flags?, rawFlags?): OpTypedResult<OpItem>

Get an item by name, id or share link Command: op item get [{ <itemName> | <itemID> | <shareLink> | - }] [flags]

Parameters​

itemIdentifier​

string

flags?​

ItemGetFlags

rawFlags?​

RawFlags

Returns​

OpTypedResult<OpItem>

itemList()​

itemList(flags?, rawFlags?): OpTypedResult<OpItemList>

List items Command: op item list [flags]

Parameters​

flags?​

ItemListFlags

rawFlags?​

RawFlags

Returns​

OpTypedResult<OpItemList>

itemEdit()​

itemEdit(itemIdentifier, assignments?, flags?, rawFlags?): OpTypedResult<OpItem>

Edit an item Command: op item edit { <itemName> | <itemID> | <shareLink> } [ <assignment> ... ] [flags]

Parameters​

itemIdentifier​

string

assignments?​

Assignments

flags?​

ItemEditFlags

rawFlags?​

RawFlags

Returns​

OpTypedResult<OpItem>

itemDelete()​

itemDelete(itemIdentifier, flags?, rawFlags?): OpTypedResult<Record<string, never>>

Delete an item Command: op item delete [{ <itemName> | <itemID> | <shareLink> | - }] [flags]

Parameters​

itemIdentifier​

string

flags?​

ItemDeleteFlags

rawFlags?​

RawFlags

Returns​

OpTypedResult<Record<string, never>>

itemMove()​

itemMove(itemIdentifier, flags?, rawFlags?): OpTypedResult<OpItem>

Move an item between vaults Command: op item move [{ <itemName> | <itemID> | <shareLink> | - }] [flags]

Parameters​

itemIdentifier​

string

flags?​

ItemMoveFlags

rawFlags?​

RawFlags

Returns​

OpTypedResult<OpItem>

itemShare()​

itemShare(itemIdentifier, flags?, rawFlags?): OpTypedResult<ShareLinkItem>

Share an item (creates a shareable link) Command: op item share { <itemName> | <itemID> } [flags]

Parameters​

itemIdentifier​

string

flags?​

ItemShareFlags

rawFlags?​

RawFlags

Returns​

OpTypedResult<ShareLinkItem>

itemTemplateGet()​

itemTemplateGet(category, flags?, rawFlags?): OpTypedResult<OpTemplate>

Get an item template for a category Command: op item template get [{ <category> | - }] [flags]

Parameters​

category​

string

flags?​

ItemTemplateGetFlags

rawFlags?​

RawFlags

Returns​

OpTypedResult<OpTemplate>

itemTemplateList()​

itemTemplateList(flags?, rawFlags?): OpTypedResult<OpTemplateList>

List available templates Command: op item template list [flags]

Parameters​

flags?​

ItemTemplateListFlags

rawFlags?​

RawFlags

Returns​

OpTypedResult<OpTemplateList>

executeCommand()​

executeCommand<T>(commands, args?, flags?): OpTypedResult<T>

Generic execute for arbitrary op commands

Type Parameters​

T​

T = unknown

Parameters​

commands​

string[]

args?​

string[]

flags?​

OpFlags

Returns​

OpTypedResult<T>

getFieldValue()​

static getFieldValue(item, field): string

Safely return a field value by purpose or label. Returns undefined if not found.

Parameters​

item​

OpItem

field​

string

Returns​

string