node package manager
We need your input. Help make JavaScript better: Take the 2017 JavaScript Ecosystem survey »



Build Status

Objectify recurses over a directory and builds an object tree that matches the directory's structure while reading the contents of each file into a property on the tree.

npm install objectify


Assuming the following directory structure:


Then calling:

var objectify = require('objectify');
var result = objectify('./templates', { extensions: ['html'] });

Would populate the result variable with an object like so:

    admin: {
        dashboard: '' // populated with the contents of ./templates/admin/dashboard.html
    blog: {
        post: {
            create: '', // populated with the contents of ./templates/post/create.html
            show: '', // populated with the contents of ./templates/post/show.html
            edit: '', // populated with the contents of ./templates/post/edit.html
        comment: {
            create: '', // populated with the contents of ./templates/comment/create.html
            show: '', // populated with the contents of ./templates/comment/show.html
            edit: '', // populated with the contents of ./templates/comment/edit.html


Objectify reads text files using utf8 encoding by default. You can specify encoding like so.

var objectify = require('objectify');
var result = objectify('./templates', { extensions: ['html'], encoding: 'ascii' });

Please note: All file operations are performed synchronously. As such, it's best to use objectify when your app starts.