view doc/html/api/module/Irccd.Directory/index.md @ 13:070a1ece2af6

Docs: fix various errors in JavaScript API
author David Demelier <markand@malikania.fr>
date Thu, 11 Feb 2016 22:02:57 +0100
parents 1158cffe5a5e
children 904ee87bc808
line wrap: on
line source

---
module: Irccd.Directory
summary: Open an read directories.
---

## Usage

This module can be used to iterate, find, remove or create directories.

Use this module with care.

## Constants

The following properties are defined:

  - **Dot**: (int) list "." directory,
  - **DotDot**: (int) list ".." directory,
  - **TypeUnknown**: (int) unknown type file,
  - **TypeDir**: (int) entry is a directory,
  - **TypeFile**: (int) entry is a file,
  - **TypeLink**: (int) entry is a link.

## Functions

  - [find](function/find.html)
  - [mkdir](function/mkdir.html)
  - [remove](function/remove.html)

## Methods

  - [(constructor)](method/constructor.html)
  - [find](method/find.html)
  - [remove](method/remove.html)