GithubHelp home page GithubHelp logo

tsedio / ts-json-properties Goto Github PK

View Code? Open in Web Editor NEW
6.0 8.0 3.0 132 KB

Use typescript decorator to retrieve a property from properties.json and load it on class attribute.

License: MIT License

TypeScript 100.00%
json-properties decorators typescript-decorators typescript nodejs

ts-json-properties's Introduction

Ts.JsonProperties

Build Status Coverage Status npm TypeScript Package Quality npm version Dependencies img img Known Vulnerabilities semantic-release code style: prettier

Use typescript decorator to retrieve a property from properties.json and load it on class attribute.

Features

  • @Value(expression) : resolve expression and values the attribute (decorator).
  • @Constant(expression) : resolve expression and values the attribute but attribut is frozen (decorator).
  • @EnvValue(expression) : resolve expression and values the attribute from process.node.env or from properties if env value doesn't exists (decorator).
  • Properties.get() : resolve expression and values the attribute (programmatic).

Installation

npm install -g typescript
npm install ts-json-properties

Example

In first place, you need to create a `properties.json in your project's root and write some data like this :

{
 "product":"MP",
  "myOwnData":{
    "data1":1
  }
}

You can separate your json in multiple json file with the attribute propertiesFile. Just adding this code on your properties.json :

{
 "product":"MP",
  "myOwnData":{
    "data1":1
  },
  "propertiesFiles":{
    "cwd":"./properties",
    "files":{
      "documents": "documents.json",
      "wsdl": "wsdl.json"
    }
  }
}

In this case, when Properties load your properties file in memory, it'll provide a JSON like this :

{
 "product":"MP",
  "myOwnData":{
    "data1":1
  },

  "documents": {
    "doc1": "/directory/docs/file.pdf"
  },
  
  "wsdl": {
    "wsdl1": "..."
  }

}

Next step, You must initialize Properties in your app.js. Just add this code for that :

import {Properties} from 'ts-json-properties';

Properties.initialize(); //Import automatically properties.json 

//or load it from another path

Properties.initialize('path/to/properties.json'); 

And finally, you use the decorator to values attributes on your class.

import {Value, Properties} from 'ts-json-properties';

export class Foo {
    
    @Value('documents.doc1')
    private documents1:string; 
    
    constructor(){
    
        console.log('Doc =>', this.documents1); // Doc => /directory/docs/file.pdf
        
        //or with Properties Api
        
        console.log('wsdl', Properties.get('wsdl')); // wsdl => {"wsdl1":"..."}
    }
}

Note : All properties returned by @Value or Properties.getValue are immutable.

From Env

Define your env variable:

export path__to__var = "1000"

Then use @EnvValue:

import {Value, Properties} from 'ts-json-properties';

export class Foo {
    @EventValue('path.to.var')
    private documents1: string; 
}

Note: if the env value is undefined, the value will be retrieved from properties.json

Test

$ npm install -g mocha
$ npm test

License

The MIT License (MIT)

Copyright (c) 2016 Romain Lenzotti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ts-json-properties's People

Contributors

romakita avatar semantic-release-bot avatar zoltanbedi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ts-json-properties's Issues

Override values in config files with environment variables

Information

Type  Version
Question 1.2.0

Description

Does ts-json-properties have the ability to override a value from a file with an environment variable or is it strictly one or the other? For example, in my aws environment the urls for dependent services could change. It's a lot easier for my deployment code to set an environment variable than change a config file.

EnvValue

Hello,

I am trying to use @EnvValue (expression).

Without defining in path the variable, I found that it does not find the variable. I fix it by concatenating "Default" to its name (would not it be better if they were called the same?).

If I define the variable and also find the variable in the properties.json uses the properties.

How can I use it correctly?

Thanks.

Fs.existsSync is not a function

core.js:1350 ERROR Error: Uncaught (in promise): TypeError: Fs.existsSync is not a function
TypeError: Fs.existsSync is not a function
at Properties.read (properties.js:22)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.