import Feature from 'devapt-core-browser/js/base/feature.js'

public class | source

Feature

Extends:

devapt-core-common/dist/js/base/loggable~Loggable → NameTypeSettingsLoggable → Feature

Example:

	API
		->get_name():string - get command name (INHERITED).
		->get_type():string - get command type (INHERITED).
		->get_settings():object - get instance type (INHERITED).
		->is_valid():boolean - check if instance is valid (settings...) (INHERITED, SUBCLASSED).

		->get_author():string|object - get author id or record.
		->get_license():string - get license name.
		->get_about():string|object - get about doc content.
		->get_help():string|object - get about doc content.
		->get_refdoc():string|object - get about doc content.

Constructor Summary

Public Constructor
public	constructor(arg_runtime: object, arg_settings: object, arg_log_context: string \| undefined): nothing Creates an instance of Feature, do not use directly but in a sub class.

Member Summary

Public Members
public	is_feature: boolean

Method Summary

Public Methods
public	get_about(): string \| object Get About content.
public	get_author(): string \| object Get Author.
public	get_help(): string \| object Get Help content.
public	get_license(): string Get License name.
public	get_refdoc(): string \| object Get Referential Docs content.
public	is_valid(): boolean Check if instance settings is valid.

Inherited Summary

From class NameTypeSettingsLoggable
public	is_name_type_settings_loggable: boolean
private	_runtime: *
private	_settings: *
private	_ui: *
public	get_name(): string Get instance name.
public	get_router(): Router Get router.
public	get_runtime(): ClientRuntime Get runtime.
public	get_settings(): string Get instance settings.
public	get_state_store(): Store Get runtime state store.
public	get_type(): string Get instance type.
public	get_ui(): UI Get UI.
public	is_valid(): boolean Check if instance settings is valid.

Public Constructors

public constructor(arg_runtime: object, arg_settings: object, arg_log_context: string | undefined): nothing source

Creates an instance of Feature, do not use directly but in a sub class.

A Feature configuration is a simple object with this common attributes:

    - name:string  - unique name.
    - type:string  - type of commnand from command factory known types list (example: display).
    - about:string - string or doc object: { 'topicA':{ 'topicA1':'...' }, 'topicB':'...' }.
    - help:string  - string or doc object: { 'topicA':{ 'topicA1':'...' }, 'topicB':'...' }.
    - refdoc:string  - string or doc object: { 'topicA':{ 'topicA1':'...' }, 'topicB':'...' }.

Override:

NameTypeSettingsLoggable#constructor

Params:

Name	Type	Attribute	Description
arg_runtime	object		runtime.
arg_settings	object		instance settings.
arg_log_context	string \| undefined		context of traces of this instance (optional).