Class SerializableProperties

Stores a serializable set of key-value pairs of various types.

Index

Constructors

Methods

deleteKey get getBoolean hasKey set setBoolean

Constructors

constructor

new SerializableProperties(): SerializableProperties

Returns SerializableProperties

Methods

deleteKey

deleteKey(name: string): void
Deletes a persistent property with the specified name.
Parameters
- name: string
  Name of the property to delete.
Returns void

get

get<T>(name: string, defaultValue?: T): T
Sets a value from a property with the specified name.
Type Parameters
- T
Parameters
- name: string
  Name to record the property under.
- OptionaldefaultValue: T
Returns T

getBoolean

getBoolean(name: string, defaultValue?: boolean): boolean
Retrieves a value of a boolean property.
Parameters
- name: string
  Name of the property to retrieve.
- OptionaldefaultValue: boolean
  Default value to return if property cannot be found.
Returns boolean
Value of the property if it exists, otherwise the default value.

hasKey

hasKey(name: string): boolean
Checks does a persistent property with the specified name exists.
Parameters
- name: string
  Name of the property to check.
Returns boolean
True if the property exists, false otherwise.

set

set<T>(name: string, value: T): void
Sets a value to a property with the specified name.
Type Parameters
- T
Parameters
- name: string
  Name to record the property under.
- value: T
  Value of the property.
Returns void

setBoolean

setBoolean(name: string, value: boolean): void
Sets a boolean value to a property with the specified name.
Parameters
- name: string
  Name to record the property under.
- value: boolean
  Value of the property.
Returns void