Mercurial > irccd
comparison doc/html/api/module/Irccd.File/method/constructor.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 | 392778b6d3c9 |
comparison
equal
deleted
inserted
replaced
| 12:960e03040ddf | 13:070a1ece2af6 |
|---|---|
| 2 method: constructor | 2 method: constructor |
| 3 summary: "Open a file specified by path with the specified mode." | 3 summary: "Open a file specified by path with the specified mode." |
| 4 synopsis: "Irccd.File(path, mode) /* constructor */" | 4 synopsis: "Irccd.File(path, mode) /* constructor */" |
| 5 arguments: | 5 arguments: |
| 6 - "path, the path to the file," | 6 - "path, the path to the file," |
| 7 - "mode, the mode, can be one of [abrwt]" | 7 - "mode, the mode string." |
| 8 throws: "Any exception on error" | 8 throws: "Any exception on error." |
| 9 --- | 9 --- |
| 10 | 10 |
| 11 The mode string understands the following characters: | 11 ## Mode |
| 12 | 12 |
| 13 - **a**: append to the end of file, | 13 The mode is the same as the `fopen(3)`, see the documentation of [std::fopen(3)][fopen] for more information |
| 14 - **b**: open in binary mode, | 14 about the mode string. |
| 15 - **r**: open for reading, | 15 |
| 16 - **w**: open for writing, | 16 [fopen]: http://en.cppreference.com/w/cpp/io/c/fopen |
| 17 - **t**: truncate the file. |