Mercurial > irccd
annotate doc/html/api/module/Irccd.File/index.md @ 263:48676ca7071c
Docs: use less hierarchy for less indexes
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 15 Sep 2016 13:16:05 +0200 |
parents | 904ee87bc808 |
children |
rev | line source |
---|---|
0 | 1 --- |
2 module: Irccd.File | |
260
904ee87bc808
CMake: split documentation into several topic, closes #535
David Demelier <markand@malikania.fr>
parents:
77
diff
changeset
|
3 js: true |
0 | 4 summary: "File opening and writing." |
5 --- | |
6 | |
7 ## Usage | |
8 | |
9 This class and functions are available for opening and writing files on the disk. | |
10 | |
11 For convenience, some functions are available as free-functions and some as object methods. | |
12 | |
13
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
13 ## Remarks |
070a1ece2af6
Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
14 |
0 | 15 <div class="alert alert-warning" role="alert"> |
16 **Warning**: the stat function and method are optional and may not be available on your system. | |
17 </div> | |
18 | |
19 ## Constants | |
20 | |
21 The following properties are defined: | |
22 | |
24
392778b6d3c9
Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
23 - **SeekCur**: (int) seek from the current file position, |
392778b6d3c9
Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
24 - **SeekEnd**: (int) seek from end of the file, |
392778b6d3c9
Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
25 - **SeekSet**: (int) seek from beginning of the file. |
0 | 26 |
27 ## Functions | |
28 | |
263
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
29 - [basename](Irccd.File.basename.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
30 - [dirname](Irccd.File.dirname.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
31 - [exists](Irccd.File.exists.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
32 - [remove](Irccd.File.remove.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
33 - [stat](Irccd.File.stat.html) (Optional) |
0 | 34 |
35 ## Methods | |
36 | |
263
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
37 - [(constructor)](Irccd.File.prototype.constructor.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
38 - [basename](Irccd.File.prototype.basename.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
39 - [close](Irccd.File.prototype.close.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
40 - [dirname](Irccd.File.prototype.dirname.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
41 - [lines](Irccd.File.prototype.lines.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
42 - [read](Irccd.File.prototype.read.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
43 - [readline](Irccd.File.prototype.readline.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
44 - [remove](Irccd.File.prototype.remove.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
45 - [seek](Irccd.File.prototype.seek.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
46 - [stat](Irccd.File.prototype.stat.html) (Optional) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
47 - [tell](Irccd.File.prototype.tell.html) |
48676ca7071c
Docs: use less hierarchy for less indexes
David Demelier <markand@malikania.fr>
parents:
260
diff
changeset
|
48 - [write](Irccd.File.prototype.write.html) |