Frontend Classes

Fields

class FieldsResolver()

Helps with creation of fields, $ref can be used to reference schema objects

FieldsResolver.FieldsResolver
FieldsResolver._resolveJsonPointer(pointer)
Arguments

  • pointer (string()) –

Returns

* –

FieldsResolver.registerField(type, format, fieldClass)
Arguments

  • type (string()) –

  • format (string()) –

  • fieldClass (function()) –

FieldsResolver.resolveField(obj, name)

Method that creates field instance by schema object or format. If schema object contain reference ($ref), it will be resolved using app.

Name must be provided if string mode is used or obj has no name.

Arguments

  • obj (string|object()) –

  • name (string()) –

Returns

BaseField –

class BaseField(options)

Constructor of base field class.

Arguments

  • options (Object()) – Object with field options.

BaseField.prepareFieldForView(path)

Method, that prepares instance of field for usage. Method is called after models and views are created, for every field instance that is part of view.

Arguments

  • path (string()) –

BaseField.afterInstancesFetched(instances, queryset)

Method that will be called after every fetch of instances from api (QuerySet#items, QuerySet#get)

Arguments
BaseField.getInitialValue()

Returns field default value if any, empty string otherwise

Returns

TInner –

BaseField.toInner(data)

Method, that converts field value to appropriate for API form.

Arguments

  • data (Object()) –

Returns

TInner –

BaseField.toRepresent(data)

Method, that converts field value from API to display form

Arguments

  • data (InnerData()) – Object with values of current field

Returns

TRepresent –

BaseField.validateValue(data)

Method that validates value.

Arguments

  • data (RepresentData()) – Object with all values.

BaseField.toDescriptor()

Method that creates property descriptor from current field

Returns

PropertyDescriptor –

class AutocompleteField()

Autocomplete guiField class.

AutocompleteField.mixins

Redefinition of string guiField static property ‘mixins’.

class BooleanField()

Field to store bool value

BooleanField.getEmptyValue()
Returns

boolean –

BooleanField.toInner(data)
Returns

boolean –

BooleanField.toRepresent(data)
Returns

boolean –

class ChoicesField(options)

Choices guiField class.

ChoicesField.mixins

Redefinition of string guiField static property ‘mixins’.

class CrontabField()

Crontab guiField class. Field to create crontab commands from GUI.

CrontabField.mixins

Redefinition of base guiField static property ‘mixins’.

CrontabField._getValue(data)

Custom method for toInner and toRepresent methods.

Arguments

  • data (object()) –

CrontabField.toInner(data)

Redefinition of base guiField method toInner.

Arguments

  • data (object()) –

CrontabField.toRepresent(data)

Redefinition of base guiField method toRepresent.

Arguments

  • data (object()) –

class DateField()

Date guiField class.

DateField.mixins

Redefinition of base guiField static property ‘mixins’.

DateField._getValue(data)

Custom method for toInner and toRepresent methods.

Arguments

  • data (object()) –

class DateTimeField()

Date-time guiField class.

DateTimeField.mixins

Redefinition of base guiField static property ‘mixins’.

class TimeIntervalField()

Time_interval guiField class. Field that gets time in milliseconds and convert it into seconds before render. Before sending data to API it converts time from seconds to milliseconds.

TimeIntervalField.mixins

Redefinition of base guiField static property ‘mixins’.

TimeIntervalField.toInner(data)

Redefinition of base guiField method toInner.

Arguments

  • data (object()) –

TimeIntervalField.toRepresent(data)

Redefinition of base guiField method toRepresent.

Arguments

  • data (object()) –

class UptimeField(options)

Uptime guiField class. Field that gets time in seconds as value and shows it in convenient way for user. Due to size of time field selects one of the most appropriate pattern from these templates: - 23:59:59 - 01d 00:00:00 - 01m 30d 00:00:00 - 99y 11m 30d 22:23:24

UptimeField.reg_exp_arr

Array of regexps for current field. These regexps are needed for converting value from seconds to uptime format.

UptimeField.mixins

Redefinition of base guiField static property ‘mixins’.

class DynamicField(options)

Dynamic guiField class.

DynamicField.types

type: Object.<string, BaseField>

DynamicField.mixins

Redefinition of base guiField static property ‘mixins’.

DynamicField.getRealField(data)

Method, that returns real field instance - some guiField instance of format, that current field should have in current moment.

Arguments

  • data (object()) – Object with values of current field and fields from the same fields wrapper. For example, from the same Model Instance.

DynamicField.toInner(data)

Redefinition of ‘toInner’ method of base guiField.

Arguments

  • data (object()) –

DynamicField.toRepresent(data)

Redefinition of ‘toRepresent’ method of base guiField.

Arguments

  • data (object()) –

class FileField(options)

File guiField class.

FileField.mixins
class BinaryFileField()

BinFile guiField class. Field takes file’s content, converts it into base64 string and sends this string to API.

BinaryFileField.mixins

Redefinition of base guiField static property ‘mixins’.

BinaryFileField.toBase64(data)

Method, that converts field’s value to base64. It’s supposed that value of current field is an instance of ArrayBuffer.

Arguments

  • data (object()) – Object with values of current field and fields from the same fields wrapper. For example, from the same Model Instance.

class NamedBinaryFileField()

NamedBinFile guiField class. This field takes and returns JSON with 2 properties: - name - string - name of file; - mediaType - string - MIME type of file - content - base64 string - content of file.

NamedBinaryFileField.mixins

Redefinition of base guiField static property ‘mixins’.

NamedBinaryFileField.validateValue(data)

Redefinition of ‘validateValue’ method of binfile guiField.

class NamedBinaryImageField(options)

NamedBinImage guiField class. This field takes and returns JSON with 2 properties: - name - string - name of image; - mediaType - string - MIME type of file; - content - base64 string - content of image.

NamedBinaryImageField.mixins

Redefinition of base guiField static property ‘mixins’.

class MultipleNamedBinFileField(options)

MultipleNamedBinFile guiField class. This field takes and returns array with objects, consisting of 2 properties: - name - string - name of file; - mediaType - string - MIME type of file; - content - base64 string - content of file.

MultipleNamedBinFileField.mixins

Redefinition of base guiField static property ‘mixins’.

MultipleNamedBinFileField.validateValue(data)

Redefinition of ‘validateValue’ method of binfile guiField.

class MultipleNamedBinaryImageField(options)

MultipleNamedBinFile guiField class. This field takes and returns array with objects, consisting of 2 properties: - name - string - name of file; - mediaType - string - MIME type of file; - content - base64 string - content of file.

MultipleNamedBinaryImageField.mixins

Redefinition of base guiField static property ‘mixins’.

class DeepFKField(options)

DeepFKField extends FkField, but displays as tree

class FKAutocompleteField(options)

FkField with autocomplete feature for GUI.

class FKField(options)

Foreign key GUI field class for nested models.

FKField._fetchRelated(pks, qs)
Arguments
Returns

Promise.<Array.<Model>> –

FKField.getAppropriateQuerySet(data, querysets, path)

Method, that selects one, the most appropriate queryset, from querysets array.

Arguments

  • data (object()) – Object with instance data.

  • querysets (array()) – Array with field QuerySets.

  • path (string()) –

Returns

QuerySet|undefined –

FKField.getDependenceFilters(data)

Method that returns dependence filters. If null is returned it means that at least one of required and non nullable fields is empty and field should be disabled.

Arguments

  • data (Object()) –

Returns

Object|null –

class FKMultiAutocompleteField()

FK_multi_autocomplete guiField class.

FKMultiAutocompleteField.mixins

Redefinition of base guiField static property ‘mixins’.

class JSONField(options, jsonMapper)

JSON guiField class.

JSONField.mixins

Redefinition of base guiField static property ‘mixins’.

class IntegerField()

Field to store integers

IntegerField.mixins

Redefinition of base guiField static property ‘mixins’.

class PasswordField()

Password guiField class.

PasswordField.mixins

Redefinition of string guiField static property ‘mixins’.

class RelatedListField()

Field shows selected fields values of related objects. On list view shows modal window.

RelatedListField.RelatedListField
class TextAreaField()

Textarea guiField class.

TextAreaField.mixins

Redefinition of base guiField static property ‘mixins’.

class ColorField()

Color guiField class.

ColorField.mixins

Redefinition of base guiField static property ‘mixins’.

ColorField._getValue(data)

Custom method for toInner and toRepresent methods.

Arguments

  • data (object()) –

ColorField.toInner(data)

Redefinition of base guiField method toInner.

Arguments

  • data (object()) –

ColorField.toRepresent(data)

Redefinition of base guiField method toRepresent.

Arguments

  • data (object()) –

class EmailField()

Email guiField class.

EmailField.mixins

Redefinition of string guiField static property ‘mixins’.

EmailField.validation_reg_exp

Static property, that returns regExp for email string validation.

EmailField.validateValue(data)

Redefinition of ‘validateValue’ method of string guiField.

Views

class ViewConstructor.ViewConstructor(openapi_dictionary, modelsResolver, fieldsResolver)

Class used to create views objects from schema

Constructor of ViewConstructor class.

Arguments

  • openapi_dictionary (object()) – Dict, that has info about properties names in OpenApi Schema and some settings for views of different types.

  • modelsResolver (ModelsResolver()) –

  • fieldsResolver (FieldsResolver()) –

ViewConstructor.ViewConstructor._generateFilters(path, parameters, listModel)

Method, that generates new guiField objects for View filters.

Returns

Object.<string, BaseField> –

ViewConstructor.ViewConstructor._getOperationModel(response)
Arguments

  • response (Object()) –

Returns

function –

ViewConstructor.ViewConstructor._getViewName(path)

Method, that returns path’s name.

Arguments

  • path (string()) – Key of path object, from OpenApi’s path dict.

ViewConstructor.ViewConstructor._setNestedQuerysets(views)

Method that sets nested querysets needed for to getting instances that can be added

Arguments

  • views (Map.) –

ViewConstructor.ViewConstructor._setParents(views)
Arguments

  • views (Map.) –

ViewConstructor.ViewConstructor.generateViews(openapi_schema)

Method, that returns dict with views, ready to use. Method creates views, sets internal links for them and so on.

Arguments

  • openapi_schema (object()) – OpenApi Schema.

Returns

Map.<string, View> – Map of views objects, ready for usage.

ViewConstructor.ViewConstructor.getOperationOptions(operationId, path, method)

Method, that return operation_id options for view schema. It gets operation_id options from openapi_dictionary and sets them.

Arguments

  • operationId (string()) – Operation_id value.

  • path (string()) – Key of path object, from OpenApi’s path dict.

  • method (string()) – Http method

ViewConstructor.ViewConstructor.getViews(schema)

Method, that creates views based on OpenApi schema.

Arguments

  • schema (object()) – OpenApi Schema.

Returns

Map.<string, View> – views Dict of views objects.

class View(params, objects, mixins)

View class - constructor, that returns view object.

Constructor of View class.

Arguments

  • params (Object()) –

  • objects (QuerySet()) –

  • mixins (Array.) –

View.View

Constructor of View class.

View.actions

type: Map.<string, Action>

View.mixins

Property, that stores extensions for components, which would render current view.

View.modelsList

Property that returns array with request and response model

View.parent

type: View|null

View.path

type: string

type: Map.<string, Sublink>

View.subscriptionLabels

type: Array.<string>|null

View._propsFunc(route)
Arguments

  • route (Route()) –

Returns

Object – component properties

View.getComponent()

Method that returns Vue component for view

Returns

Object –

View.getRoutePath()

Method returns string with template of route path for current view.

Returns

string –

View.getStoreModule()

Returns custom store module

Returns

Object|undefined –

View.toRoute()

Method that returns route object for view (RouteConfig)

Returns

Object –

QuerySets

class QuerySet(pattern, models, query, pathParams)

Base QuerySet class.

Arguments

  • pattern (string()) – Must be without leading and ending slashes

  • models (ModelsConfiguration()) – Models classes

  • query (Object()) – Object with query parameters

  • pathParams (Array.) – Object that describes path parameters

QuerySet._isModelInstance(obj)

Function that checks if given object is instance of Model

Arguments

  • obj (*()) –

Returns

boolean –

QuerySet.all()

Method, that returns new QuerySet with current value of ‘this.query’ property.

QuerySet.clearCache()

Method, that cleans QuerySet cache.

QuerySet.clone(props, save_cache=false)

Method, that returns clone (new QuerySet instance) of current QuerySet.

Arguments

  • props (object()) – Object with properties, that should be rewritten in clone.

  • save_cache (boolean()) – If true, cache of current QuerySet will be saved in clone.

Returns

QuerySet – Clone - new QuerySet instance.

QuerySet.copy(props)

Method, that returns copy (new QuerySet instance) of current QuerySet, with cache of current QuerySet.

Arguments

  • props (object()) – Object with properties, that should be rewritten in copy instance.

Returns

object – Copy - new QuerySet instance.

QuerySet.create(instance, method)

Method, that sends query to API for creation of new Model instance and returns promise, that returns Model instance, if query response was successful.

Arguments

  • instance (Model()) – new model data.

  • method (string()) – Http method.

Returns

Promise.<Model> –

QuerySet.delete(instances, purge=false)

Method, that deletes provided instances or all instances that match current queryset items(). This method is expected to be called after instance filtering.

Arguments

  • instances (Array.) –

  • purge (boolean()) –

Returns

Promise –

QuerySet.exclude(filters)

Method, that returns new QuerySet with new filters, that will be saved in ‘query’ property.

Arguments

  • filters (object()) – Object with filters(key, value), according to which some instances should be excluded from Model instances list.

QuerySet.execute(req)

Method, that sends API request to ApiConnector.

Arguments

  • req (Object()) – Request parameters.

  • req.method (string()) – Http method.

  • req.version (string()) – API version.

  • req.path (string|Array.) –

  • req.query (string|Object|URLSearchParams()) – URL query params.

  • req.data (Model()) –

  • req.headers (string|Object()) –

  • req.useBulk (boolean()) –

Returns

Promise.<APIResponse> –

QuerySet.filter(filters)

Method, that returns new QuerySet with new filters, that will be saved in ‘query’ property.

Arguments

  • filters (object()) – Object with filters(key, value), according to which Model instances list should be sorted.

Returns

QuerySet –

QuerySet.get(id, pathParamsValues)

Method, that returns promise with Model instance.

Returns

Promise.<Model> –

QuerySet.getDataType()

Getter that returns queryset urls as string array

Returns

Array.<string> –

QuerySet.getModelClass(operation, modelType=1)

Method that returns proper model for specified operation. If custom operation type used and model for that type exists in configuration it will be returned. If no appropriate model found, than null is returned.

Order used to determine model class: PARTIAL_UPDATE / UPDATE -> CREATE -> RETRIEVE -> LIST

Arguments

  • operation (RequestType()) –

  • modelType (number()) – 0 for request and 1 for response

Returns

function|null –

QuerySet.getOne(pathParamsValues)

Method returns one instance, if more than one instance found error is thrown

Returns

Promise.<Model> –

QuerySet.getRequestModelClass(operation)

Method that returns request model for given operation

Arguments

  • operation (RequestType()) –

Returns

function|null –

QuerySet.getResponseModelClass(operation)

Method that returns response model for given operation

Arguments

  • operation (RequestType()) –

Returns

function|null –

QuerySet.items(invalidateCache, pathParamsValues)

Method, that sends to API get request for getting list of Model instances, appropriate for filters from ‘this.query’ property. Method, returns promise, that returns list of Model instances, if api request was successful.

Returns

Promise.<Array.<Model>> –

QuerySet.update(updatedInstance, instances, method, fields=null)

Method, that sends api request for model update

Arguments

  • updatedInstance (Model()) –

  • instances (Array.) – Model instances to update.

  • method (HttpMethod()) – Http method, PATCH by default.

  • fields (null|Array.) –

Returns

Array.<Promise.<Model>> –

class QuerySetsResolver(viewsTree)

QuerySetsResolver chooses appropriate queryset for path.

Arguments

  • viewsTree (ViewsTree()) –

QuerySetsResolver.QuerySetsResolver
QuerySetsResolver._getMatcher(modelName)
Arguments

  • modelName (string()) –

Returns

function –

Models

class Model(data=null, queryset=null, parentInstance=null)

Class of Base Model.

Arguments

  • data (InnerData()) –

  • queryset (QuerySet()) –

  • parentInstance (Model()) –

  • _name (string()) – Model name

  • _fields (Map.) –

  • _pkField (BaseField()) –

  • _viewField (BaseField()) –

  • _pkFieldName (string|null()) –

Model.Model
Model.declaredFields

type: Array.<BaseField>

Model.fieldsGroups

type: Object.<string, Array.<string>>

Model.nonBulkMethods

type: Array.<string>|null

Model.translateModel

type: string|null

Model.viewFieldName

type: string|null

Model._getInnerData(fieldsNames)
Arguments

  • @property (Array.) – [fieldsNames]

Returns

InnerData –

Model._getRepresentData()
Returns

RepresentData –

Model._validateAndSetData(data)
Arguments

  • data (RepresentData()) –

Throws

ModelValidationError() –

Model.create(method="post")

Method, that creates new Model instance.

Arguments

  • method (string()) – Http method

Returns

Promise.<Model> –

Model.delete(purge)

Method, that sends api request to delete Model instance.

Returns

Promise –

Model.getPkValue()

Method, that returns instance’s value of PK field.

Model.getViewFieldString(escapeResult=true)

Returns value of view field as safe escaped string or undefined if model has no view field.

Arguments

  • escapeResult (boolean()) –

Returns

string|undefined –

Model.getViewFieldValue(defaultValue)

Method, that returns instance’s value of view field.

Model.isEqual(other)

Checks if this instance’s data is equal to data of the provided instance

Arguments

  • other (Model|Object()) –

Returns

boolean –

Model.parseModelError(data)
Arguments

  • data (Object()) –

Returns

ModelValidationError|undefined –

Model.save(method)

Method that saves current model instance

Arguments

  • method (string()) – Http method

Returns

Promise.<Model> –

Model.update(method, fields=null)

Method to update model data

Arguments

  • method (string()) –

  • fields (null|Array.) –

Returns

Promise.<Model> –

Model.getInitialData(providedData)
Arguments

  • providedData (Object()) –

Returns

InnerData –

Model.shouldUseBulk(method)
Arguments

  • method (HttpMethod()) –

Returns

boolean –

class ModelsResolver(fieldsResolver, schema)

ModelsResolver Resolves model by reference path

Arguments
ModelsResolver.ModelsResolver
ModelsResolver.byReferencePath(reference)

Resolves model by reference path

Arguments

  • reference (string()) –

Returns

function|undefined –

ModelsResolver.bySchemaObject(modelSchema, modelName)

Resolves model by schema object. Schema object or $ref is supported.

Arguments

  • modelSchema (Object()) –

  • modelName (string()) –

Returns

function –

See also

  • {@link https://swagger.io/specification/v2/#schemaObject}

App

class BaseApp(config, cache)

Constructor of App class.

Arguments

  • config (AppConfiguration()) – Object with OpenAPI schema.

  • cache (FakeCache()) – Object, that manages api responses cache operations.

class App(config, cache)

Class for a App object. App object - JS object, that has all properties, needed for an application work.

Constructor of App class.

Arguments

  • config (AppConfiguration()) – Object with OpenAPI schema.

  • cache (FakeCache()) – Cache instance (is supposed to be instance of FilesCache class).

App.App

Constructor of App class.

App.application

Main(root) Vue instance for current application, that has access to the app store and app router.

App.qsResolver

type: QuerySetsResolver

App.views

type: Map.<string, View>

App._prefetchTranslation(lang)

Method returns a promise of checking that current language exists and translations for language is loaded. This method is supposed to be called after app was mounted and only from this.setLanguage(lang) method.

Arguments

  • lang (string()) – Code of language, that should be prefetched.

Returns

Promise –

App.prepare()

Method, that creates store and router for an application and mounts it to DOM.

App.setLanguage(lang)

Method returns a promise of applying some language to app interface. This method is supposed to be called after app was mounted.

Arguments

  • lang (string()) – Code of language, that should be set as current App language.

Returns

Promise –

ErrorHandler

Class, that is responsible for showing of pop up notification.

Constructor of PopUp class.

Arguments

  • options (object()) – Object with pop up settings.

PopUp.PopUp

Constructor of PopUp class.

PopUp.default(message, opt)

Method, that generates default pop up notification.

Arguments

  • message (string()) – Body text of pop up notification.

  • opt (object()) – Object with custom settings for pop up notification.

PopUp.error(message, opt)

Method, that generates error pop up notification.

Arguments

  • message (string()) – Body text of pop up notification.

  • opt (object()) – Object with custom settings for pop up notification.

PopUp.info(message, opt)

Method, that generates info pop up notification.

Arguments

  • message (string()) – Body text of pop up notification.

  • opt (object()) – Object with custom settings for pop up notification.

PopUp.question(message, answer_buttons, opt)

Method, that generates question pop up. Returns promise of getting user’s answer.

Arguments

  • message (string()) – Question text.

  • answer_buttons (array()) – Array of strings - titles for answer buttons.

  • opt (object()) – Object with custom settings for question pop up.

Returns

promise – .

PopUp.success(message, opt)

Method, that generates success pop up notification.

Arguments

  • message (string()) – Body text of pop up notification.

  • opt (object()) – Object with custom settings for pop up notification.

PopUp.warning(message, opt)

Method, that generates warning pop up notification.

Arguments

  • message (string()) – Body text of pop up notification.

  • opt (object()) – Object with custom settings for pop up notification.

class ApiConnector()

Class, that sends API requests.

Constructor of ApiConnector class.

ApiConnector.ApiConnector

Constructor of ApiConnector class.

ApiConnector.appConfig

type: AppConfiguration

ApiConnector.bulk_collector

Property for collecting several bulk requests into one.

ApiConnector._bulkItemToRequest(request)
Arguments

  • request (BulkRequest()) –

ApiConnector._sendCollectedBulks()

Method, that sends one big bulk request to API.

Returns

Promise – Promise of getting bulk request response.

ApiConnector.bulkQuery(data)

Method, that collects several bulk requests into one.

Arguments

  • data (BulkRequest()) – Body of bulk request.

Returns

Promise.<BulkResponse> –

ApiConnector.getHostUrl()

Method returns URL of API host (server).

Returns

string –

ApiConnector.getStaticPath()

Method returns relative path (from host url) to the directory with static path.

Returns

string –

ApiConnector.getTimeZone()

Method returns string, containing time zone of API host.

Returns

string –

ApiConnector.getUserId()

Method returns id of user, that is now authorized and uses application.

Returns

number|string –

ApiConnector.initConfiguration(appConfig)

Method that sets application configuration. Must be called before making any requests.

Arguments

  • appConfig (AppConfiguration()) –

Returns

ApiConnector –

ApiConnector.loadUser()

Method, that loads data of authorized user.

Returns

Promise – Promise of getting data of authorized user.

ApiConnector.makeRequest(obj, useBulk)

Method, that sends API request.

Arguments

  • obj (Object()) – Request parameters.

  • obj.method (string()) – Http method.

  • obj.version (string()) – API version.

  • obj.path (string|Array.) –

  • obj.query (string|Object|URLSearchParams()) – URL query params.

  • obj.data (string|FormData()) –

  • obj.headers (string|Object|URLSearchParams()) –

  • useBulk (boolean()) – Make request using bulk request.

Returns

Promise.<APIResponse> –

ApiConnector.sendBulk(requests, type)
Arguments

  • requests (Array.) –

  • type (string()) – bulk type

Returns

Promise.<Array.<BulkResponse>> –

class RouterConstructor(views, custom_components_templates)

Constructor of RouterConstructor Class.

Arguments

  • views (Map.) – Map with views objects. generated by View class and having description in OpenAPI Schema.

  • custom_components_templates (object()) – Dict with mixins for Vue components of custom Views, that have no description in OpenAPI Schema (home page, 404 error page).

class StoreConstructor(app, enableStrictMode)

Class, that manages Store creation. Store - object, that contains data of all App components. In current realization, Store is Vuex Store. More about Vuex - https://vuex.vuejs.org/.

Constructor of StoreConstructor class.

Arguments

  • app (App()) –

  • enableStrictMode (boolean()) –

StoreConstructor.StoreConstructor

Constructor of StoreConstructor class.

StoreConstructor.getStore()

Method, that returns App store.

StoreConstructor.getStore_actions()

Method, that forms store actions - asynchronous operations. More about action - https://vuex.vuejs.org/guide/actions.html.

StoreConstructor.getStore_getters()

Method, that forms store getters - properties/methods, that return data from store. More about getters - https://vuex.vuejs.org/guide/getters.html.

StoreConstructor.getStore_mutations()

Method, that forms store mutations - single way of state changing in Vuex store. More about mutations - https://vuex.vuejs.org/guide/mutations.html.

StoreConstructor.getStore_state()

Method, that forms ‘state’ property of Store object.

LocalSettings is an abstraction, that is responsible for manipulating by settings saved to the Local Storage. It is used for saving some user’s local settings to the one property(object) of Local Storage.

For example:

window.localStorage.localSettings = {
    hideMenu: true,
    lang: "en",
    skin: "default"
}
class LocalSettings(name)

Constructor of LocalSettings Class.

Arguments

  • name (string()) – Key name of Local Storage’s property to which Local Settings will be saved.