UNPKG

1.06 kBTypeScriptView Raw
1import { Configuration } from "./loader/config";
2/**
3 * Main RecSys integration module.
4 *
5 * @export
6 * @abstract
7 * @class RecSys
8 */
9export default abstract class RecSys {
10 /**
11 * Initialization method. This needs to be run before using any of this
12 * modules features.
13 *
14 * @static
15 * @param {Configuration} config Store configuration.
16 * @memberof RecSys
17 */
18 static init(config: Configuration): void;
19 /**
20 * Merge current configuration provided by the store with
21 * the default configuration, filling in the blanks.
22 *
23 * @static
24 * @param {Configuration} config Current configuration
25 * @return {Configuration}
26 * @memberof RecSys
27 */
28 static mergeConfig(config: Configuration): Configuration;
29 /**
30 * Environment running right now.
31 * NOTE: This comes from `recsys build`.
32 *
33 * @private
34 * @static
35 * @param {Configuration} config Configuration
36 * @return {string} Current environment
37 * @memberof RecSys
38 */
39 private static env;
40}