TypeScript icon, indicating that this package has built-in type declarations

    5.0.0 • Public • Published

    @ngx-config/fs-loader npm version npm downloads

    Loader for ngx-config that provides application settings using fs (server platform)

    CircleCI coverage tested with jest Conventional Commits Angular Style Guide

    Please support this project by simply putting a Github star. Share this library with friends on Twitter and everywhere else you can.


    This 5.x.x branch is intented to work with @angular v5.x.x. If you're developing on a later release of Angular than v5.x.x, then you should probably choose the appropriate version of this library by visiting the master branch.

    Table of contents:


    This library depends on Angular v4.0.0. Older versions contain outdated dependencies, might produce errors.

    Also, please ensure that you are using Typescript v2.5.3 or higher.

    Getting started


    You can install @ngx-config/fs-loader using npm

    npm install @ngx-config/fs-loader --save

    Note: You should have already installed @ngx-config/core.


    Related packages

    The following packages may be used in conjunction with @ngx-config/fs-loader:

    Adding @ngx-config/fs-loader to your project (SystemJS)

    Add map for @ngx-config/fs-loader in your systemjs.config

    '@ngx-config/fs-loader': 'node_modules/@ngx-config/fs-loader/bundles/fs-loader.umd.min.js'


    Setting up ConfigModule to use ConfigFsLoader

    If you provide application settings using a JSON file (on the server platform), you can call the forRoot static method using the ConfigFsLoader. By default, it is configured to retrieve application settings from the path /config.json (if not specified).

    You can customize this behavior (and ofc other settings) by supplying a file path to ConfigFsLoader.

    • Import ConfigModule using the mapping '@ngx-config/core' and append ConfigModule.forRoot({...}) within the imports property of app.module.
    • Import ConfigFsLoader using the mapping '@ngx-config/fs-loader'.

    Note: Considering the app.module is the core module in Angular application.


      "system": {
        "applicationName": "Mighty Mouse",
        "applicationUrl": "http://localhost:8000"
      "seo": {
        "pageTitle": "Tweeting bird"
        "locale": "en"


    import { ConfigModule, ConfigLoader } from '@ngx-config/core';
    import { ConfigFsLoader } from '@ngx-config/fs-loader';
    export function configFactory(): ConfigLoader {
      return new ConfigFsLoader('./public/assets/config.json'); // FILE PATH
      declarations: [
      imports: [
          provide: ConfigLoader,
          useFactory: (configFactory)
      bootstrap: [AppComponent]

    ConfigFsLoader has one parameter:

    • path: string : path to JSON file, to retrieve application settings from (by default, config.json)

    👍 Well! @ngx-config/fs-loader will now provide application settings to @ngx-config/core using fs.


    The MIT License (MIT)

    Copyright (c) 2018 Burak Tasci


    npm i @ngx-config/fs-loader

    DownloadsWeekly Downloads






    Last publish


    • fulls1z3