@tramvai/core NPM

title: '@tramvai/core'

sidebar_position: 1

Core

Ядро tramvai. В основном требуется для разработки модулей трамвая.

API

createApp

createApp - configuring, creating and running the application

createApp({ modules, bundles, providers })

modules - array with used modules in the application
bundles - object with used bundles with data in the application. The key is the bundle identifier, the value is Promise which returns the bundle
providers - an array with application providers, which will be added last in the DI (after module providers) and thus it will be possible to overwrite the implementation of the tokens
actions - array with global actions, which will be registered for all bundles and pages

Usage

import { createApp, provide } from '@tramvai/core';
import { RouterModule } from '@tramvai/module-router';
import { RenderModule } from '@tramvai/module-render';
import { ServerModule } from '@tramvai/module-server';

createApp({
  name: 'my-awesome-app',
  modules: [RouterModule, RenderModule, ServerModule],
  providers: [
    provide({
      provide: 'options',
      useValue: {},
    }),
  ],
  bundles: {
    mainDefault: () => import(/* webpackChunkName: "mainDefault" */ './bundles/mainDefault'),
  },
  actions: [loadDepositConfig],
});

After calling createApp, СommandLineRunner is started which performs the chain of actions necessary to initialize the application.

Module

Module - Decorator for configuring and creating a module.

@Module({ providers, deps, imports })(class)

providers - Providers, which will be added to the root DI container and become available in other modules
deps - List of dependencies from the DI container, necessary to initialize the module
imports - A list of modules from which providers will be obtained and added to the DI. Allows you to create modules that combine many other modules

Usage

import { Module, provide } from '@tramvai/core';

@Module({
  providers: [
    provide({
      provide: 'token',
      useValue: 'value-in-token',
    }),
  ],
  deps: {
    logger: 'logger',
  },
  imports: [ModuleLogger],
})
class ModulePubSub {
  constructor({ logger }) {
    logger.info('Module create');
  }
}

createAction

createAction - Method for creating asynchronous actions. It is used both for building chains of sagas and for performing global actions when building a response to a client

More about actions

createAction({ name, fn, deps, conditions })

name - The name of the action, a unique identifier is expected
fn(context, payload, deps) - Implementation of the action, this function will be called when the action is used, maybe async
- context - ConsumerContext
- payload - data passed to action
- deps - provider instances from deps
deps - List of providers that are needed for the action to work
conditions - List of restrictions for the execution of the action

Usage example

import { createAction } from '@tramvai/core';

createAction({
  name: 'action log error',
  fn: (context, payload, deps) => {
    deps.logger.error('ERROR');
  },
  deps: {
    logger: 'logger',
  },
  conditions: {
    requiredCoreRoles: ['god'],
  },
});

createBundle

createBundle(options: BundleOptions) - method to create a bundle.

Properties BundleOptions

name - Name of the bundle. The value will be used as a bundle identifier.
components: {} - An object with registered components for the bundle, which you can use in application routes
presets?: [] - A list of additional properties for the current bundle. This list is merged with the current properties. Needed to extract common parts, e.g. a set with actions and components for authorization. Reference - babel and eslint presets
actions?: [] - List of actions that will be registered globally for the bundle
reducers?: [] - List of reducers, which must be registered with the loading of the bundle

Usage

import { createBundle } from '@tramvai/core';
import { lazy } from '@tramvai/react';

createBundle({
  name: 'app/bundle',
  presets: [commonPreset],
  components: {
    'app/pages/MainPage': lazy(() => import('../pages/MainPage')),
    'app/pages/SecondPage': lazy(() => import('../pages/SecondPage')),
  },
  actions: [fooAction, barAction],
  reducers: [bazReducer],
});

Exported tokens

DI_TOKEN

Dependency Injection container implementation

APP_INFO_TOKEN

Information about running application

COMMAND_LINE_RUNNER_TOKEN

CommandLineRunner implementation

COMMAND_LINES_TOKEN

Commands for CommandLineRunner

@tinkoff/utils @tramvai/tokens-common @tramvai/tokens-core @tramvai/types-actions-state-context @tinkoff/dippy node-abort-controller tslib

@everything-registry/sub-chunk-930 @zalastax/nolb-_tram @tramvai/child-app-core @tramvai/module-metrics @tramvai/module-dns-cache @tramvai/test-child-app @tramvai/test-helpers @tramvai/test-mocks @tramvai/test-unit @tramvai/react-query

4 days ago

10 days ago

14 days ago

14 days ago

15 days ago

15 days ago

15 days ago

15 days ago

19 days ago

19 days ago

19 days ago

19 days ago

23 days ago

23 days ago

25 days ago

25 days ago

25 days ago

26 days ago

26 days ago

26 days ago

26 days ago

27 days ago

27 days ago

29 days ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

6 months ago

8 months ago

8 months ago

7 months ago

8 months ago

8 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

10 months ago

7 months ago

7 months ago

9 months ago

10 months ago

9 months ago

10 months ago

10 months ago

8 months ago

8 months ago

7 months ago

7 months ago

7 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

6 months ago

6 months ago

8 months ago

8 months ago

8 months ago

6 months ago

6 months ago

6 months ago

8 months ago

8 months ago

8 months ago

7 months ago

8 months ago

8 months ago

9 months ago

9 months ago

9 months ago

7 months ago

9 months ago

8 months ago

7 months ago

8 months ago

10 months ago

6 months ago

6 months ago

9 months ago

9 months ago

6 months ago

9 months ago

7 months ago

9 months ago

8 months ago

8 months ago

10 months ago

6 months ago

9 months ago

7 months ago

9 months ago

10 months ago

8 months ago

10 months ago

10 months ago

10 months ago

8 months ago

8 months ago

8 months ago

10 months ago

9 months ago

9 months ago

8 months ago

9 months ago

9 months ago

8 months ago

9 months ago

9 months ago

8 months ago

9 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

11 months ago

11 months ago

11 months ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

11 months ago

12 months ago

11 months ago

11 months ago

11 months ago

1 year ago

1 year ago

12 months ago

12 months ago

1 year ago

1 year ago

12 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

2 years ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago