Home » Javascript » How do I load the contents of a text file into a javascript variable?

How do I load the contents of a text file into a javascript variable?

Posted by: admin November 30, 2017 Leave a comment

Questions:

I have a text file in the root of my web app http://localhost/foo.txt and I’d like to load it into a variable in javascript.. in groovy I would do this:

def fileContents = 'http://localhost/foo.txt'.toURL().text;
println fileContents;

How can I get a similar result in javascript?

Answers:

XMLHttpRequest, i.e. AJAX, without the XML.

The precise manner you do this is dependent on what JavaScript framework you’re using, but if we disregard interoperability issues, your code will look something like:

var client = new XMLHttpRequest();
client.open('GET', '/foo.txt');
client.onreadystatechange = function() {
  alert(client.responseText);
}
client.send();

Normally speaking, though, XMLHttpRequest isn’t available on all platforms, so some fudgery is done. Once again, your best bet is to use an AJAX framework like jQuery.

One extra consideration: this will only work as long as foo.txt is on the same domain. If it’s on a different domain, same-origin security policies will prevent you from reading the result.

Questions:
Answers:

here is how I did it in jquery:

jQuery.get('http://localhost/foo.txt', function(data) {
    alert(data);
});

Questions:
Answers:

If you only want a constant string from the text file, you could include it as JavaScript:

// This becomes the content of your foo.txt file
let text = `
My test text goes here!
`;
<script src="foo.txt"></script>
<script>
  console.log(text);
</script>

The string loaded from the file becomes accessible to JavaScript after being loaded. The `(backtick) character begins and ends a template literal, allowing for both ” and ‘ characters in your text block.

This approach works well when you’re attempting to load a file locally, as Chrome will not allow AJAX on URLs with the file:// scheme.

Questions:
Answers:

One thing to keep in mind is that Javascript runs on the client, and not on the server. You can’t really “load a file” from the server in Javascript. What happens is that Javascript sends a request to the server, and the server sends back the contents of the requested file. How does Javascript receive the contents? That’s what the callback function is for. In Edward’s case, that is

    client.onreadystatechange = function() {

and in danb’s case, it is

 function(data) {

This function is called whenever the data happen to arrive. The jQuery version implicitly uses Ajax, it just makes the coding easier by encapsulating that code in the library.

Questions:
Answers:

When working with jQuery, instead of using jQuery.get, e.g.

jQuery.get("foo.txt", undefined, function(data) {
    alert(data);
}, "html").done(function() {
    alert("second success");
}).fail(function(jqXHR, textStatus) {
    alert(textStatus);
}).always(function() {
    alert("finished");
});

you could use .load which gives you a much more condensed form:

$("#myelement").load("foo.txt");

.load gives you also the option to load partial pages which can come in handy, see api.jquery.com/load/.

Questions:
Answers:

If your input was structured as XML, you could use the importXML function. (More info here at quirksmode).

If it isn’t XML, and there isn’t an equivalent function for importing plain text, then you could open it in a hidden iframe and then read the contents from there.