@base-framework/base 3.0.257 → 3.0.259

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,6 +7,8 @@
7
7
  * @class
8
8
  * @augments Unit
9
9
  *
10
+ * @param {...any} args
11
+ *
10
12
  * @example
11
13
  * class QuickFlashPanel extends Component
12
14
  * {
@@ -6,6 +6,8 @@
6
6
  * This will allow units to be extended
7
7
  * from a single factory.
8
8
  *
9
+ * @param {...any} args
10
+ *
9
11
  * @example
10
12
  * class Alert extends Unit
11
13
  * {
@@ -22,82 +24,9 @@ export class Unit {
22
24
  * This will create a unit.
23
25
  *
24
26
  * @constructor
25
- *
26
- * @overload
27
- * @param {object} props
28
- * @param {Array<object>} [children=[]] - An array of children
29
- *
30
- * @overload
31
- * @param {Array<object>} [children=[]] - An array of children
32
- *
33
- * @overload
34
- * @param {string} [children] - A child string
35
- *
36
- * @overload
37
- * @param {object} props
38
- * @param {string} [children] - A child string
39
- */
40
- constructor(props: object, children?: Array<object>);
41
- /**
42
- * This will create a unit.
43
- *
44
- * @constructor
45
- *
46
- * @overload
47
- * @param {object} props
48
- * @param {Array<object>} [children=[]] - An array of children
49
- *
50
- * @overload
51
- * @param {Array<object>} [children=[]] - An array of children
52
- *
53
- * @overload
54
- * @param {string} [children] - A child string
55
- *
56
- * @overload
57
- * @param {object} props
58
- * @param {string} [children] - A child string
59
- */
60
- constructor(children?: Array<object>);
61
- /**
62
- * This will create a unit.
63
- *
64
- * @constructor
65
- *
66
- * @overload
67
- * @param {object} props
68
- * @param {Array<object>} [children=[]] - An array of children
69
- *
70
- * @overload
71
- * @param {Array<object>} [children=[]] - An array of children
72
- *
73
- * @overload
74
- * @param {string} [children] - A child string
75
- *
76
- * @overload
77
- * @param {object} props
78
- * @param {string} [children] - A child string
79
- */
80
- constructor(children?: string);
81
- /**
82
- * This will create a unit.
83
- *
84
- * @constructor
85
- *
86
- * @overload
87
- * @param {object} props
88
- * @param {Array<object>} [children=[]] - An array of children
89
- *
90
- * @overload
91
- * @param {Array<object>} [children=[]] - An array of children
92
- *
93
- * @overload
94
- * @param {string} [children] - A child string
95
- *
96
- * @overload
97
- * @param {object} props
98
- * @param {string} [children] - A child string
27
+ * @param {...any} args
99
28
  */
100
- constructor(props: object, children?: string);
29
+ constructor(...args: any[]);
101
30
  /**
102
31
  * @member {boolean} isUnit
103
32
  */
@@ -33,8 +33,17 @@ export class BasicData {
33
33
  * @param {object} [settings]
34
34
  */
35
35
  constructor(settings?: object);
36
+ /**
37
+ * @member {boolean} dirty
38
+ * @default false
39
+ */
36
40
  dirty: boolean;
37
- links: {};
41
+ /**
42
+ * @member {object} links
43
+ * @default {}
44
+ * @protected
45
+ */
46
+ protected links: {};
38
47
  /**
39
48
  * @member {string} dataTypeId
40
49
  */
@@ -47,6 +56,9 @@ export class BasicData {
47
56
  * @returns {void}
48
57
  */
49
58
  protected setup(): void;
59
+ /**
60
+ * @member {object} stage
61
+ */
50
62
  stage: {};
51
63
  /**
52
64
  * This will setup the number and unique id of the data object.
@@ -1 +1 @@
1
- export function setupAttrSettings(settings: object): object;
1
+ export function setupAttrSettings(settings?: object): object;
@@ -21,7 +21,7 @@ export class ModelService {
21
21
  */
22
22
  constructor(model: object);
23
23
  /**
24
- * @member {object} model
24
+ * @member {Model} model
25
25
  */
26
26
  model: any;
27
27
  /**
@@ -16,6 +16,11 @@ export class Model extends Data {
16
16
  * @returns {object}
17
17
  */
18
18
  static extend(settings?: object): object;
19
+ /**
20
+ * @member {string|null} url
21
+ * @default null
22
+ */
23
+ url: any;
19
24
  /**
20
25
  * @member {object|null} xhr
21
26
  */
@@ -17,17 +17,17 @@ export class StateTracker {
17
17
  * This will restore a state target.
18
18
  *
19
19
  * @param {string} id
20
- * @param {object} target
20
+ * @param {StateTarget} target
21
21
  * @returns {void}
22
22
  */
23
- static restore(id: string, target: object): void;
23
+ static restore(id: string, target: StateTarget): void;
24
24
  /**
25
25
  * This will get the state target.
26
26
  *
27
27
  * @param {string} id
28
- * @returns {object}
28
+ * @returns {StateTarget}
29
29
  */
30
- static getTarget(id: string): object;
30
+ static getTarget(id: string): StateTarget;
31
31
  /**
32
32
  * This will get the state of an action.
33
33
  *
@@ -43,18 +43,18 @@ export class StateTracker {
43
43
  * @param {string} targetId
44
44
  * @param {string} [action]
45
45
  * @param {*} [state] the primary action state
46
- * @returns {object}
46
+ * @returns {StateTarget}
47
47
  */
48
- static add(targetId: string, action?: string, state?: any): object;
48
+ static add(targetId: string, action?: string, state?: any): StateTarget;
49
49
  /**
50
50
  * This will add a new action to a target.
51
51
  *
52
52
  * @param {string} targetId
53
53
  * @param {string} action
54
54
  * @param {string} [state]
55
- * @returns {object}
55
+ * @returns {StateTarget}
56
56
  */
57
- static addAction(targetId: string, action: string, state?: string): object;
57
+ static addAction(targetId: string, action: string, state?: string): StateTarget;
58
58
  /**
59
59
  * This will remove the action from a target.
60
60
  *
@@ -101,3 +101,4 @@ export class StateTracker {
101
101
  */
102
102
  static set(targetId: string, action: string, state: any): void;
103
103
  }
104
+ import { StateTarget } from './state-target.js';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@base-framework/base",
3
- "version": "3.0.257",
3
+ "version": "3.0.259",
4
4
  "description": "This is a javascript framework.",
5
5
  "main": "./dist/base.js",
6
6
  "type": "module",