INativeKeychainAccess.md

@js-soft/native-abstractions / Exports / INativeKeychainAccess

Interface: INativeKeychainAccess

Access to native keychain

Table of contents

Methods

• delete
• get
• init
• list
• set

Methods

delete

▸ delete(key): Promise<Result<void, ApplicationError>>

Delete key-value pair

Parameters

Name	Type
key	string

Returns

Promise<Result<void, ApplicationError>>

Defined in

src/INativeKeychainAccess.ts:30

---

get

▸ get(key): Promise<Result<INativeKeychainEntry, ApplicationError>>

Get value for the specified {@link key}

Parameters

Name	Type	Description
key	string	string identifying a value

Returns

Promise<Result<INativeKeychainEntry, ApplicationError>>

Defined in

src/INativeKeychainAccess.ts:19

---

init

▸ init(): Promise<Result<void, ApplicationError>>

Initialize the module

Returns

Promise<Result<void, ApplicationError>>

Defined in

src/INativeKeychainAccess.ts:38

---

list

▸ list(): Promise<Result<INativeKeychainEntry[], ApplicationError>>

List all key-value pairs added by the applicaion

Returns

Promise<Result<INativeKeychainEntry[], ApplicationError>>

Defined in

src/INativeKeychainAccess.ts:34

---

set

▸ set(key, value): Promise<Result<void, ApplicationError>>

Add key-value pair to keychain

Parameters

Name	Type
key	string
value	any

Returns

Promise<Result<void, ApplicationError>>

Defined in

src/INativeKeychainAccess.ts:25