Feature request: asArray() about env-var HOT 15 CLOSED

Do you guys think it's a good idea to add trim for the asArray, because there might be spaces in the csv format env var for readability, e.g. COLOR="red, green, blue"

from env-var.

@henriklundgren nice idea. Would you be able to provide some pseudo/sample code for how you'd like this to work?

I think the current asJson would work for some scenarios, but asArray could ensure the result is an Array and not an Object. For example, this is currently possible:

var env = require('env-var');

// ARRAY is set to "[1, 2, 3, 4]"
// OBJECT is set to "{"name":"env-var"}"

var arr = env('ARRAY').asJson();
var obj = env('OBJECT').asJson();

But neither of these check that the parsed entry is truly and Object or an Array. So were you thinking this maybe?

var env = require('env-var');

// ARRAY is set to "[1, 2, 3, 4]"
// OBJECT is set to "{"name":"env-var"}"

var arr = env('ARRAY').asArray();
var obj = env('OBJECT').asObject();

env('OBJECT').asArray(); // throws an error since the json is actually an object

from env-var.

Atm I do;

function asArray(str: string): string[] {
  return str.split(',');
}
asArray(env('LIST').required().asString());

$ env LIST=red,blue,green npm start

from env-var.

@henriklundgren I see, would you be opposed to doing the following (adding array braces in the env var):

$ env LIST=["red","blue","green"] npm start

and then this module could expose an asArray function, and your code would be like so:

env('LIST').required().asArray()

If this doesn't work for you then perhaps a function named asCommaSeparatedArray could be added. Thoughts?

from env-var.

I believe csv's is more or less defacto standard to pass ArgumentList,
at least thats how I pass lists to the cli applications I use on daily basis.
I am reluctant to change that unless you are able to convince me.

from env-var.

I'm with you, just trying to figure out the best overall approach.

JSON in environment variables is a little weird for sure, and many CLI tools just denote arrays using comma or space characters like you say. So perhaps we add a new function to env-var like so:

# your original setup
$env LIST=red,blue,green npm start

var colours = env('LIST').required().asArrayWithDelimieter(','); 

or

var colours = env('LIST').required().fromArrayWithDelimieter(','); 
console.log(colours) // => ['red','blue','green']

This means you can use comma, or other chars to separate array elements. Thoughts?

from env-var.

Actually, just asArray(',') is fine, since we can also add asJsonArray() which will implement my original suggestion.

from env-var.

Appreciate the follow ups,

I guess that works,
though,
for completeness sake,
may I through out a third alternative,

asArray({
	delimiter: ‘,’, // any string
	type: 'csv', // enum [‘csv’, ‘json’]
})

from env-var.

@henriklundgren can you explain the need for type with an example of what the environment variable should be in the case of each?

My understanding of your example is that type would determine how env-var does the parsing, but for json there's no need for a delimiter, right?

I think we're almost there on figuring out a solid approach.

from env-var.

Yes, delimiter would loose its meaning if json.

I guess mainly my attempt to avoid polluting the method name scope,
with names that means the same on face value level.
I.e. take a list of values (any) and turn it in to a javascript list (array).

as[Array/List](type[, delimiter])
// or
as[Array/List]([type][, delimiter]) // all optional, default json
// or
"red,greeb,blue".asList(',')
['red','blue','green'].asArray() // json, wouldnt this be the same as asJson()?

from env-var.

Gotcha, I'm thinking we need 3 functions:

• asJsonObject (This is not related to this issue, but I need it)
• asJsonArray (Is somewhat related to this issue, will be needed in the future and fits into the JSON namespace)
• asArray([delimiter])

I don't think "type" is necessary right now based on this discussion.

I can start on this later, unless you already have something done? 😄

from env-var.

Released in version 2.4. Let me know how it is @henriklundgren 😄

from env-var.

Thank you, works great, I can finally get rid of my little helper function. 🎉

from env-var.

Great! TypeScript definitions are also available 🎉

from env-var.

@xavierchow I'd considered that, but decided against it to keep things simple. Might be able to support it via an option though.

from env-var.