Skip to content

Commit

Permalink
refactor: consistent naming of injection tokens
Browse files Browse the repository at this point in the history
  • Loading branch information
markostanimirovic committed Oct 18, 2020
1 parent 01ad2cd commit f4a6353
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 23 deletions.
6 changes: 4 additions & 2 deletions modules/component-store/src/component-store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ export interface SelectConfig {
debounce?: boolean;
}

export const initialStateToken = new InjectionToken('ComponentStore InitState');
export const INITIAL_STATE_TOKEN = new InjectionToken(
'@ngrx/component-store Initial State'
);

@Injectable()
export class ComponentStore<T extends object> implements OnDestroy {
Expand All @@ -49,7 +51,7 @@ export class ComponentStore<T extends object> implements OnDestroy {
// Needs to be after destroy$ is declared because it's used in select.
readonly state$: Observable<T> = this.select((s) => s);

constructor(@Optional() @Inject(initialStateToken) defaultState?: T) {
constructor(@Optional() @Inject(INITIAL_STATE_TOKEN) defaultState?: T) {
// State can be initialized either through constructor or setState.
if (defaultState) {
this.initState(defaultState);
Expand Down
2 changes: 1 addition & 1 deletion modules/data/src/effects/entity-effects-scheduler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ import { SchedulerLike } from 'rxjs';
// See https://github.com/ReactiveX/rxjs/blob/master/doc/marble-testing.md
/** Token to inject a special RxJS Scheduler during marble tests. */
export const ENTITY_EFFECTS_SCHEDULER = new InjectionToken<SchedulerLike>(
'EntityEffects Scheduler'
'@ngrx/data Entity Effects Scheduler'
);
2 changes: 1 addition & 1 deletion modules/data/src/entity-metadata/entity-metadata.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { EntityDispatcherDefaultOptions } from '../dispatchers/entity-dispatcher
import { EntityFilterFn } from './entity-filters';

export const ENTITY_METADATA_TOKEN = new InjectionToken<EntityMetadataMap>(
'@ngrx/data/entity-metadata'
'@ngrx/data Entity Metadata'
);

/** Metadata that describe an entity type and its collection to @ngrx/data */
Expand Down
8 changes: 4 additions & 4 deletions modules/data/src/reducers/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ import { EntityCache } from './entity-cache';

export const ENTITY_CACHE_NAME = 'entityCache';
export const ENTITY_CACHE_NAME_TOKEN = new InjectionToken<string>(
'@ngrx/data/entity-cache-name'
'@ngrx/data Entity Cache Name'
);

export const ENTITY_CACHE_META_REDUCERS = new InjectionToken<
MetaReducer<any, any>[]
>('@ngrx/data/entity-cache-meta-reducers');
>('@ngrx/data Entity Cache Meta Reducers');
export const ENTITY_COLLECTION_META_REDUCERS = new InjectionToken<
MetaReducer<any, any>[]
>('@ngrx/data/entity-collection-meta-reducers');
>('@ngrx/data Entity Collection Meta Reducers');

export const INITIAL_ENTITY_CACHE_STATE = new InjectionToken<
EntityCache | (() => EntityCache)
>('@ngrx/data/initial-entity-cache-state');
>('@ngrx/data Initial Entity Cache State');
2 changes: 1 addition & 1 deletion modules/data/src/selectors/entity-cache-selector.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {

export const ENTITY_CACHE_SELECTOR_TOKEN = new InjectionToken<
MemoizedSelector<Object, EntityCache>
>('@ngrx/data/entity-cache-selector');
>('@ngrx/data Entity Cache Selector');

export const entityCacheSelectorProvider: FactoryProvider = {
provide: ENTITY_CACHE_SELECTOR_TOKEN,
Expand Down
2 changes: 1 addition & 1 deletion modules/data/src/utils/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface EntityPluralNames {
}

export const PLURAL_NAMES_TOKEN = new InjectionToken<EntityPluralNames>(
'@ngrx/data/plural-names'
'@ngrx/data Plural Names'
);

export abstract class Pluralizer {
Expand Down
15 changes: 6 additions & 9 deletions modules/effects/src/tokens.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,21 @@ import { EffectsErrorHandler } from './effects_error_handler';
export const _ROOT_EFFECTS_GUARD = new InjectionToken<void>(
'@ngrx/effects Internal Root Guard'
);
export const IMMEDIATE_EFFECTS = new InjectionToken<any[]>(
'ngrx/effects: Immediate Effects'
);
export const USER_PROVIDED_EFFECTS = new InjectionToken<Type<any>[][]>(
'ngrx/effects: User Provided Effects'
'@ngrx/effects User Provided Effects'
);
export const _ROOT_EFFECTS = new InjectionToken<Type<any>[]>(
'ngrx/effects: Internal Root Effects'
'@ngrx/effects Internal Root Effects'
);
export const ROOT_EFFECTS = new InjectionToken<Type<any>[]>(
'ngrx/effects: Root Effects'
'@ngrx/effects Root Effects'
);
export const _FEATURE_EFFECTS = new InjectionToken<Type<any>[]>(
'ngrx/effects: Internal Feature Effects'
'@ngrx/effects Internal Feature Effects'
);
export const FEATURE_EFFECTS = new InjectionToken<any[][]>(
'ngrx/effects: Feature Effects'
'@ngrx/effects Feature Effects'
);
export const EFFECTS_ERROR_HANDLER = new InjectionToken<EffectsErrorHandler>(
'ngrx/effects: Effects Error Handler'
'@ngrx/effects Effects Error Handler'
);
4 changes: 2 additions & 2 deletions modules/store-devtools/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ export class StoreDevtoolsConfig {
}

export const STORE_DEVTOOLS_CONFIG = new InjectionToken<StoreDevtoolsConfig>(
'@ngrx/devtools Options'
'@ngrx/store-devtools Options'
);
export const INITIAL_OPTIONS = new InjectionToken<StoreDevtoolsConfig>(
'@ngrx/devtools Initial Config'
'@ngrx/store-devtools Initial Config'
);

export type StoreDevtoolsOptions =
Expand Down
2 changes: 1 addition & 1 deletion modules/store-devtools/src/extension.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export const ExtensionActionTypes = {

export const REDUX_DEVTOOLS_EXTENSION = new InjectionToken<
ReduxDevtoolsExtension
>('Redux Devtools Extension');
>('@ngrx/store-devtools Redux Devtools Extension');

export interface ReduxDevtoolsExtensionConnection {
subscribe(listener: (change: any) => void): void;
Expand Down
2 changes: 1 addition & 1 deletion modules/store-devtools/src/instrument.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import {
import { DevtoolsDispatcher } from './devtools-dispatcher';

export const IS_EXTENSION_OR_MONITOR_PRESENT = new InjectionToken<boolean>(
'Is Devtools Extension or Monitor Present'
'@ngrx/store-devtools Is Devtools Extension or Monitor Present'
);

export function createIsExtensionOrMonitorPresent(
Expand Down

0 comments on commit f4a6353

Please sign in to comment.