0.5.5 • Published 10 months ago

@aigens/aigens-sdk-preferences v0.5.5

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

aigens-sdk-preferences

Aigens SDK Preferences

Install

npm install @aigens/aigens-sdk-preferences
npx cap sync

API

get(...)

get(options: GetOptions) => Promise<GetResult>
ParamType
optionsGetOptions

Returns: Promise<GetResult>


set(...)

set(options: SetOptions) => Promise<void>
ParamType
optionsSetOptions

remove(...)

remove(options: RemoveOptions) => Promise<void>
ParamType
optionsRemoveOptions

clear()

clear() => Promise<void>

saveImmediately()

saveImmediately() => Promise<void>

setIsAutoSaveNormal(...)

setIsAutoSaveNormal(options: { isAutoSave: boolean; }) => Promise<void>
ParamType
options{ isAutoSave: boolean; }

setIsAutoSaveMember(...)

setIsAutoSaveMember(options: { isAutoSave: boolean; }) => Promise<void>
ParamType
options{ isAutoSave: boolean; }

enableUserDefault(...)

enableUserDefault(options: { enable: boolean; }) => Promise<void>
ParamType
options{ enable: boolean; }

keys()

keys() => Promise<KeysResult>

Returns: Promise<KeysResult>


log(...)

log(options: { log: string; logDirName?: string; toTop?: boolean; }) => Promise<{ result: number; message?: string; }>
ParamType
options{ log: string; logDirName?: string; toTop?: boolean; }

Returns: Promise<{ result: number; message?: string; }>


deleteLog(...)

deleteLog(options?: { keepMonths?: number | undefined; logDirName?: string | undefined; } | undefined) => Promise<void>
ParamType
options{ keepMonths?: number; logDirName?: string; }

Interfaces

GetResult

PropTypeDescriptionSince
valuestring | nullThe value from preferences associated with the given key. If a value was not previously set or was removed, value will be null.1.0.0

GetOptions

PropTypeDescriptionSince
keystringThe key whose value to retrieve from preferences.1.0.0

SetOptions

PropTypeDescriptionSince
keystringThe key to associate with the value being set in preferences.1.0.0
valuestringThe value to set in preferences with the associated key.1.0.0

RemoveOptions

PropTypeDescriptionSince
keystringThe key whose value to remove from preferences.1.0.0

KeysResult

PropTypeDescriptionSince
keysstring[]The known keys in preferences.1.0.0
0.5.4

10 months ago

0.5.3

10 months ago

0.5.5

10 months ago

0.5.0

1 year ago

0.5.2

10 months ago

0.5.1

10 months ago

0.4.2

1 year ago

0.4.1

1 year ago

0.4.0

1 year ago