External Javascript File: Correct way to pass configuration parameters

Question

I have an external javascript file called test.js as seen below. This file needs user configuration parameters passed to it, in this case user and show values.

<script type="text/javascript">
<!--//
  user = '123';
  show = 'appts';
//-->
</script>
<script src="{{ STATIC_URL }}js/widgets/test.js" type="text/javascript"></script>

Above is currently how I tell 3rd parties to add the script to their own site. However, I cannot help to feel this is a bad way to pass these values i.e. clashes.

Is the way I have done it acceptable? Is there a better way?

Grim... · Accepted Answer · 2014-04-01 09:09:51Z

2

A simple answer would be to append something to your variable names, such as:

<script type="text/javascript">
<!--//
  widget_test_12331_user = '123';
  widget_test_12331_show = 'appts';
//-->
</script>

answered Apr 1, 2014 at 9:09

Grim...

17k7 gold badges47 silver badges62 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Grim... Over a year ago

Um... I'm totally claiming that as an April Fools joke. Yes, that's what happened. Ahem.

ElmoVanKielmo · Accepted Answer · 2014-04-01 09:12:58Z

2

You can stick to namespace convention "reverted domain":

<script type="text/javascript">
<!--//
if (!org) var org = {};
if (!org.mylibrary_domain) org.mylibrary_domain = {};
if (!org.mylibrary_domain.settings) org.mylibrary_domain.settings = {};
org.mylibrary_domain.settings.user = '123';
org.mylibrary_domain.settings.show = 'appts';
//-->
</script>
<script src="{{ STATIC_URL }}js/widgets/test.js" type="text/javascript"></script>

answered Apr 1, 2014 at 9:12

ElmoVanKielmo

11.4k2 gold badges35 silver badges51 bronze badges

Comments

Community · Accepted Answer · 2017-05-23 12:11:11Z

2

You can use the concept of javascript namespace (How do I declare a namespace in JavaScript?).

so you can add another js file named testConfig.js, which include :

var yourAppNamespaceTestConfig = {
    user: function(){ return '123' ;} ,
    show: function(){ return 'appts';}
};

then inside test.js, you can read the config by:

var user = yourAppNamespaceTestConfig.user();
var show = yourAppNamespaceTestConfig.show();

And if you're more about OO, try Coffeescript (http://coffeescript.org/). They introduce OO to your javascript.

edited May 23, 2017 at 12:11

CommunityBot

11 silver badge

answered Apr 1, 2014 at 9:37

Dio Phung

6,3525 gold badges41 silver badges55 bronze badges

1 Comment

ElmoVanKielmo Over a year ago

But why do you need functions for retrieving user and show value?

Collectives™ on Stack Overflow

External Javascript File: Correct way to pass configuration parameters

3 Answers 3

1 Comment

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related