Angular Environment Query

Gets the properties from the EnvironmentState.

This class provides multiple ways to consume EnvironmentState properties synchronously and asynchronously, plus other options like marking properties as required, interpolating values ​​in properties, etc. Typically this will be the class that is exposed to the rest of the application to get the properties.

The environment query is an interface that must be implemented to get the environment values. Can be integrated into any application using the provided default implementation or a custom one.

DefaultEnvironmentQuery

The default environment query implementation to get the environment values.

This query is provided by defaut when running EnvironmentModule.forRoot(), but can be provided manually.

import { Provider } from '@angular/core';
import { EnvironmentQuery } from '@kuoki/environment';
import { DefaultEnvironmentQuery } from '@kuoki/environment-angular';

export const ENVIRONMENT_QUERY_PROVIDER: Provider = {
  provide: EnvironmentQuery,
  useClass: DefaultEnvironmentQuery
};

Unless ENVIRONMENT_QUERY_CONFIG is provided, the initial query config is null.

ENVIRONMENT_QUERY_CONFIG

The ENVIRONMENT_QUERY_CONFIG injection token contains the configuration parameters for the environment query.

import { Provider } from '@angular/core';
import { ENVIRONMENT_QUERY_CONFIG } from '@kuoki/environment-angular';

export const ENVIRONMENT_QUERY_CONFIG_PROVIDER: Provider = {
  provide: ENVIRONMENT_QUERY_CONFIG,
  useValue: { transpileEnvironment: true }
};

The default value provided by EnvironmentModule.forRoot() is null, but can be set in configuration.

import { EnvironmentModule } from '@kuoki/environment-angular';

EnvironmentModule.forRoot({ queryConfig: { transpileEnvironment: true } });

Use cases

Below are examples of the expected behavior and some implementation examples. To learn more about environment query and how to create them you can read the documentation.

Table of Contents

1. Create a custom query

Create a custom query

To create a custom environment query that uses ENVIRONMENT_QUERY_CONFIG simply complete the next class.

import { Inject, Injectable, Optional } from '@angular/core';
import { EnvironmentQueryConfig, EnvironmentStore } from '@kuoki/environment';

import { DefaultEnvironmentQuery, ENVIRONMENT_QUERY_CONFIG } from '@kuoki/environment-angular';

@Injectable()
export class CustomEnvironmentQuery extends DefaultEnvironmentQuery {
  constructor(
    protected override readonly store: EnvironmentStore,

    @Optional()
    @Inject(ENVIRONMENT_QUERY_CONFIG)
    protected override readonly queryConfig?: EnvironmentQueryConfig | null
  ) {
    super(store, queryConfig);
  }
}

Once implemented must be provided:

1. Using the EnvironmentModule.forRoot().

import { EnvironmentModule } from '@kuoki/environment-angular';
import { CustomEnvironmentQuery } from './custom-environment.query.ts';

EnvironmentModule.forRoot({ query: CustomEnvironmentQuery });

2. Using a provider.

import { Provider } from '@angular/core';
import { EnvironmentQuery } from '@kuoki/environment';
import { CustomEnvironmentQuery } from './custom-environment.query.ts';

export const ENVIRONMENT_QUERY_PROVIDER: Provider = {
  provide: EnvironmentQuery,
  useClass: CustomEnvironmentQuery
};