Register to get access to free programming courses with interactive exercises

Virtual file system JS: Trees

In this course, we'll create a virtual (not real) file system and implement everyday operations to work with it, such as calculating free space, searching for files and directories, etc. Let's create a file tree:

import { mkdir, mkfile } from '@hexlet/immutable-fs-trees';

// mkdir takes a list of children as its second parameter,
// which can either be directories created by mkdir,
// or files created by mkfile
const tree = mkdir('etc', [
  mkfile('bashrc'),
  mkdir('consul', [
    mkfile('config.json'),
  ]),
]);

The result is this structure:

etc
├── bashrc
└── consul
    └── config.json

By embedding mkdir and mkfile calls into other mkdir calls, any file structure can be obtained. The root of this structure will be the directory, and the leaves may contain both files and empty directories.

This structure is virtual, i.e., files and directories aren't created. All file system information stored in the tree variable. If you print it, you'll see the following:

{
  name: 'etc',
  type: 'directory',
  meta: {},
  children: [
    {
      name: 'bashrc',
      type: 'file',
      meta: {},
    },
    {
      name: 'consul',
      type: 'directory',
      meta: {},
      children: [
        {
          name: 'config.json',
          type: 'file',
          meta: {},
        }
      ],
    },
  ],
};

This is an internal implementation of the file tree. It consists of two types of nodes: directories and files.

Directory representation:

{
  name: /* ... */,
  type: 'directory',
  meta: {}, // Directory properties
  children: [/* ... */], // Here is where the children are kept
}

File representation:

{
  name: /* ... */,
  type: 'file',
  meta: {}, // File Properties
}

Files and directories have names, that's something they have in common. The type property defines the type of node and can be used to understand what is in front of us when processing this tree. meta is an object with arbitrary data, such as size, creation date and so on. Properties are set when the nodes are created:

mkfile('.bashrc', { size: 75 });
mkdir('hexlet', [/* children */], { owner: 'nobody' });

The metadata will be needed for functions that analyze the tree, such as those for calculating space usage.


Recommended materials

  1. @hexlet/immutable-fs-trees docs

Hexlet Experts

Are there any more questions? Ask them in the Discussion section.

The Hexlet support team or other students will answer you.

About Hexlet learning process

For full access to the course you need a professional subscription.

A professional subscription will give you full access to all Hexlet courses, projects and lifetime access to the theory of lessons learned. You can cancel your subscription at any time.

Get access
130
courses
1000
exercises
2000+
hours of theory
3200
tests

Sign up

Programming courses for beginners and experienced developers. Start training for free

  • 130 courses, 2000+ hours of theory
  • 1000 practical tasks in a browser
  • 360 000 students
By sending this form, you agree to our Personal Policy and Service Conditions

Our graduates work in companies:

<span class="translation_missing" title="translation missing: en.web.courses.lessons.registration.bookmate">Bookmate</span>
<span class="translation_missing" title="translation missing: en.web.courses.lessons.registration.healthsamurai">Healthsamurai</span>
<span class="translation_missing" title="translation missing: en.web.courses.lessons.registration.dualboot">Dualboot</span>
<span class="translation_missing" title="translation missing: en.web.courses.lessons.registration.abbyy">Abbyy</span>
Suggested learning programs

From a novice to a developer. Get a job or your money back!

Frontend Developer icon
Profession
beginner
Development of front-end components for web applications
start anytime 10 months

Use Hexlet to the fullest extent!

  • Ask questions about the lesson
  • Test your knowledge in quizzes
  • Practice in your browser
  • Track your progress

Sign up or sign in

By sending this form, you agree to our Personal Policy and Service Conditions

Toto Image

Ask questions if you want to discuss a theory or an exercise. Hexlet Support Team and experienced community members can help find answers and solve a problem.