diff doc/html/api/module/Irccd.File/method/constructor.md @ 0:1158cffe5a5e

Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 070a1ece2af6
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/api/module/Irccd.File/method/constructor.md	Mon Feb 08 16:43:14 2016 +0100
@@ -0,0 +1,17 @@
+---
+method: constructor
+summary: "Open a file specified by path with the specified mode."
+synopsis: "Irccd.File(path, mode) /* constructor */"
+arguments:
+  - "path, the path to the file,"
+  - "mode, the mode, can be one of [abrwt]"
+throws: "Any exception on error"
+---
+
+The mode string understands the following characters:
+
+  - **a**: append to the end of file,
+  - **b**: open in binary mode,
+  - **r**: open for reading,
+  - **w**: open for writing,
+  - **t**: truncate the file.
\ No newline at end of file