Class: AppState
app.AppState
Application state
Hierarchy
-
↳
AppState
Constructors
constructor
• new AppState()
Inherited from
Properties
_errors
• _errors: Err[] = []
Defined in
_propertySerializationOptions
• _propertySerializationOptions:
SerializationOptions[]
Inherited from
Storable._propertySerializationOptions
Defined in
account
• account: null | Account = null
Currently logged in Account
Defined in
authInfo
• authInfo: null | AuthInfo = null
Authentication Information, such as active sessions, trusted devices etc.
Defined in
context
• context: AppContext = {}
Defined in
device
• device: DeviceInfo
Info about current device
Defined in
id
• id: string = "app-state"
Overrides
Defined in
index
• index: Index
Defined in
lastUsed
• lastUsed: Map<string, Date>
IDs of most recently used items. The most recently used item is last
Defined in
offline
• offline: boolean = false
Whether the app doesn't have an internet connection at the moment
Defined in
orgs
• orgs: Org[] = []
All organizations the current account is a member of.
Defined in
rememberedMasterKey
• rememberedMasterKey: null | StoredMasterKey
= null
Defined in
session
• session: null | Session = null
Current Session
Defined in
settings
• settings: Settings
Application Settings
Defined in
stats
• stats: Stats
Usage data
Defined in
syncing
• syncing: boolean = false
Whether a sync is currently in process.
Defined in
vaults
• vaults: Vault[] = []
All vaults the current account has access to.
Defined in
Accessors
kind
• get kind(): string
A string representing the objects "type", useful for segmenting storage, among other things. Defaults to the lowercase class name, but can be overwritten by subclasses
Returns
string
Inherited from
Storable.kind
Defined in
locked
• get locked(): boolean
Whether the app is in "locked" state
Returns
boolean
Defined in
loggedIn
• get loggedIn(): boolean
Whether a user is logged in
Returns
boolean
Defined in
tags
• get tags(): [string, number][]
All Tags found within the users Vaults
Returns
[string, number][]
Defined in
Methods
_fromRaw
▸ Protected _fromRaw(raw): void
Restore values from a raw object. The default implementation simply copies over all iterable properties from the base object. Overwrite this method for properties that require special treatment
Parameters
| Name | Type |
|---|---|
raw |
any |
Returns
void
Inherited from
Defined in
_toRaw
▸ Protected _toRaw(version): any
Transform this object into a raw javascript object used for serialization. The default implementation simply copies all iterable properties not included in the [[exlude]] array and calls toRaw on any properties that are themselfes instances of Serializable. This method should be overwritten by subclasses if certain properties require special treatment.
Parameters
| Name | Type |
|---|---|
version |
undefined | string |
Returns
any
Inherited from
Defined in
clone
▸ clone(): AppState
Creates a deep clone of the object
Returns
Inherited from
Defined in
fromBytes
▸ fromBytes(bytes): AppState
Deserializes the object from a byte array
Parameters
| Name | Type |
|---|---|
bytes |
Uint8Array |
Returns
Inherited from
Defined in
fromJSON
▸ fromJSON(json): AppState
Deserializes the object from a JSON string
Parameters
| Name | Type |
|---|---|
json |
string |
Returns
Inherited from
Defined in
fromRaw
▸ fromRaw(raw): AppState
Restores propertiers from a raw object of the same form generated by
toRaw. The base implementation blindly copies over
values from the raw object via Object.assign so subclasses should explictly
process any propertyies that need special treatment.
Also takes are of validation and "upgrading" in case the raw object has an old version. Use the protected _fromRaw method to implement subclass-specific behavior.
Parameters
| Name | Type |
|---|---|
raw |
any |
Returns
Inherited from
Defined in
toBytes
▸ toBytes(): Uint8Array
Returns a serialization of the object in form of a byte array
Returns
Uint8Array
Inherited from
Defined in
toJSON
▸ toJSON(): string
Returns a JSON serialization of the object
Returns
string
Inherited from
Defined in
toRaw
▸ toRaw(version?): any
Creates a raw javascript object representation of the class, which can be used for storage or data transmission. Also handles "downgrading" to previous versions. Use _toRaw for subclass-specific behavior.
Parameters
| Name | Type |
|---|---|
version? |
string |
Returns
any
Inherited from
Defined in
validate
▸ validate(): boolean
This is called during deserialization and should verify that all properties have been populated with values of the correct type. Subclasses should implement this method based on their class structure.
Returns
boolean