Permalink
Browse files

Change readme markdown syntax to appease Github

  • Loading branch information...
1 parent 1f8530a commit 5f5224cfe034a3ed43c915d42a67b7b8caa56be6 @mscdex committed Nov 6, 2012
Showing with 32 additions and 32 deletions.
  1. +32 −32 README.md
View
@@ -248,89 +248,89 @@ API
Client properties
-----------------
-* **connected** - <_boolean_> - Set to true if the Client is currently connected.
+* **connected** - < _boolean_ > - Set to true if the Client is currently connected.
-* **threadId** - <_string_> - If connected, this is the thread id of this connection on the server.
+* **threadId** - < _string_ > - If connected, this is the thread id of this connection on the server.
Client events
-------------
* **connect**() - Connection and authentication with the server was successful.
-* **error**(<_Error_>err) - An error occurred at the connection level.
+* **error**(< _Error_ >err) - An error occurred at the connection level.
-* **close**(<_boolean_>hadError) - The connection was closed. `hadError` is set to true if this was due to a connection-level error.
+* **close**(< _boolean_ >hadError) - The connection was closed. `hadError` is set to true if this was due to a connection-level error.
Client methods
--------------
* **(constructor)**() - Creates and returns a new Client instance.
-* **connect**(<_object_>config) - _(void)_ - Attempts a connection to a server using the information given in `config`:
+* **connect**(< _object_ >config) - _(void)_ - Attempts a connection to a server using the information given in `config`:
- * **user** - <_string_> - Username for authentication. **Default:** (\*nix: current login name, Windows: ???)
+ * **user** - < _string_ > - Username for authentication. **Default:** (\*nix: current login name, Windows: ???)
- * **password** - <_string_> - Password for authentication. **Default:** (blank password)
+ * **password** - < _string_ > - Password for authentication. **Default:** (blank password)
- * **host** - <_string_> - Hostname or IP address of the MySQL/MariaDB server. **Default:** "localhost"
+ * **host** - < _string_ > - Hostname or IP address of the MySQL/MariaDB server. **Default:** "localhost"
- * **port** - <_integer_> - Port number of the MySQL/MariaDB server. **Default:** 3306
+ * **port** - < _integer_ > - Port number of the MySQL/MariaDB server. **Default:** 3306
- * **multiStatements** - <_boolean_> - Allow multiple statements to be executed in a single "query" (e.g. `connection.query('SELECT 1; SELECT 2; SELECT 3')`) on this connection. **Default:** false
+ * **multiStatements** - < _boolean_ > - Allow multiple statements to be executed in a single "query" (e.g. `connection.query('SELECT 1; SELECT 2; SELECT 3')`) on this connection. **Default:** false
- * **db** - <_string_> - A database to automatically select after authentication. **Default:** (no db)
+ * **db** - < _string_ > - A database to automatically select after authentication. **Default:** (no db)
- * **connTimeout** - <_integer_> - Number of seconds to wait for a connection to be made. **Default:** 10
+ * **connTimeout** - < _integer_ > - Number of seconds to wait for a connection to be made. **Default:** 10
- * **pingInterval** - <_integer_> - Number of seconds between pings while idle. **Default:** 300
+ * **pingInterval** - < _integer_ > - Number of seconds between pings while idle. **Default:** 300
- * **secureAuth** - <_boolean_> - Use password hashing available in MySQL 4.1.1+ when authenticating. **Default:** true
+ * **secureAuth** - < _boolean_ > - Use password hashing available in MySQL 4.1.1+ when authenticating. **Default:** true
- * **compress** - <_boolean_> - Use connection compression? **Default:** false
+ * **compress** - < _boolean_ > - Use connection compression? **Default:** false
- * **ssl** - <_mixed_> - If boolean true, defaults listed below and default ciphers will be used, otherwise it must be an object with any of the following valid properties: **Default:** false
+ * **ssl** - < _mixed_ > - If boolean true, defaults listed below and default ciphers will be used, otherwise it must be an object with any of the following valid properties: **Default:** false
- * **key** - <_string_> - Path to a client private key file in PEM format (if the key requires a passphrase and libmysqlclient was built with yaSSL (bundled Windows libraries are), an error will occur). **Default:** (none)
+ * **key** - < _string_ > - Path to a client private key file in PEM format (if the key requires a passphrase and libmysqlclient was built with yaSSL (bundled Windows libraries are), an error will occur). **Default:** (none)
- * **cert** - <_string_> - Path to a client certificate key file in PEM format. **Default:** (none)
+ * **cert** - < _string_ > - Path to a client certificate key file in PEM format. **Default:** (none)
- * **ca** - <_string_> - Path to a file in PEM format that contains a list of trusted certificate authorities. **Default:** (none)
+ * **ca** - < _string_ > - Path to a file in PEM format that contains a list of trusted certificate authorities. **Default:** (none)
- * **capath** - <_string_> - Path to a directory containing certificate authority certificate files in PEM format. **Default:** (none)
+ * **capath** - < _string_ > - Path to a directory containing certificate authority certificate files in PEM format. **Default:** (none)
- * **cipher** - <_string_> - A colon-delimited list of ciphers to use when connecting. **Default:** "ECDHE-RSA-AES128-SHA256:AES128-GCM-SHA256:RC4:HIGH:!MD5:!aNULL:!EDH" (if cipher is set to anything other than false or non-empty string)
+ * **cipher** - < _string_ > - A colon-delimited list of ciphers to use when connecting. **Default:** "ECDHE-RSA-AES128-SHA256:AES128-GCM-SHA256:RC4:HIGH:!MD5:!aNULL:!EDH" (if cipher is set to anything other than false or non-empty string)
- * **rejectUnauthorized** - <_boolean_> - If true, the connection will be rejected if the Common Name value does not match that of the host name. **Default:** false
+ * **rejectUnauthorized** - < _boolean_ > - If true, the connection will be rejected if the Common Name value does not match that of the host name. **Default:** false
-* **query**(<_string_>query[, <_mixed_>values[, <_boolean_>useArray=false]]) - <_Results_> - Enqueues the given `query` and returns a _Results_ object. `values` can be an object or array containing values to be used when replacing placeholders in `query` (see prepare()). If `useArray` is set to true, then an array of field values are returned instead of an object of fieldName=>fieldValue pairs. (Note: using arrays performs much faster)
+* **query**(< _string_ >query[, < _mixed_ >values[, < _boolean_ >useArray=false]]) - < _Results_ > - Enqueues the given `query` and returns a _Results_ object. `values` can be an object or array containing values to be used when replacing placeholders in `query` (see prepare()). If `useArray` is set to true, then an array of field values are returned instead of an object of fieldName=>fieldValue pairs. (Note: using arrays performs much faster)
-* **prepare**(<_string_>query) - <_function_> - Generates a re-usable function for `query` when it contains placeholders (can be simple `?` position-based or named `:foo_bar1` placeholders or any combination of the two). In the case that the function does contain placeholders, the generated function is cached per-connection if it is not already in the cache (currently the cache will hold at most **30** prepared queries). The returned function takes an object or array and returns the query with the placeholders replaced by the values in the object or array. **Note:** Every value is converted to a (utf8) string when filling the placeholders.
+* **prepare**(< _string_ >query) - < _function_ > - Generates a re-usable function for `query` when it contains placeholders (can be simple `?` position-based or named `:foo_bar1` placeholders or any combination of the two). In the case that the function does contain placeholders, the generated function is cached per-connection if it is not already in the cache (currently the cache will hold at most **30** prepared queries). The returned function takes an object or array and returns the query with the placeholders replaced by the values in the object or array. **Note:** Every value is converted to a (utf8) string when filling the placeholders.
-* **escape**(<_string_>value) - <_string_> - Escapes `value` for use in queries. **_This method requires a live connection_**.
+* **escape**(< _string_ >value) - < _string_ > - Escapes `value` for use in queries. **_This method requires a live connection_**.
* **end**() - _(void)_ - Closes the connection once all queries in the queue have been executed.
* **destroy**() - _(void)_ - Closes the connection immediately, even if there are other queries still in the queue.
-* **isMariaDB**() - <_boolean_> - Returns true if the remote server is MariaDB.
+* **isMariaDB**() - < _boolean_ > - Returns true if the remote server is MariaDB.
Client static methods
---------------------
-* **escape**(<_string_>value) - <_string_> - Escapes `value` for use in queries. **_This method does not take into account character encodings_**.
+* **escape**(< _string_ >value) - < _string_ > - Escapes `value` for use in queries. **_This method does not take into account character encodings_**.
Results events
--------------
-* **result**(<_Query_>res) - `res` represents the result of a single query.
+* **result**(< _Query_ >res) - `res` represents the result of a single query.
* **abort**() - The results were aborted (the 'end' event will not be emitted) by way of results.abort().
-* **error**(<_Error_>err) - An error occurred while processing this set of results (the 'end' event will not be emitted).
+* **error**(< _Error_ >err) - An error occurred while processing this set of results (the 'end' event will not be emitted).
* **end**() - All queries in this result set finished _successfully_.
@@ -344,13 +344,13 @@ Results methods
Query events
------------
-* **row**(<_mixed_>row) - `row` is either an object of fieldName=>fieldValue pairs **or** just an array of the field values (in either case, JavaScript nulls are used for MySQL NULLs), depending on how query() was called.
+* **row**(< _mixed_ >row) - `row` is either an object of fieldName=>fieldValue pairs **or** just an array of the field values (in either case, JavaScript nulls are used for MySQL NULLs), depending on how query() was called.
* **abort**() - The query was aborted (the 'end' event will not be emitted) by way of query.abort().
-* **error**(<_Error_>err) - An error occurred while executing this query (the 'end' event will not be emitted).
+* **error**(< _Error_ >err) - An error occurred while executing this query (the 'end' event will not be emitted).
-* **end**(<_object_>info) - The query finished _successfully_. `info` contains statistics such as 'affectedRows', 'insertId', and 'numRows.'
+* **end**(< _object_ >info) - The query finished _successfully_. `info` contains statistics such as 'affectedRows', 'insertId', and 'numRows.'
Query methods

0 comments on commit 5f5224c

Please sign in to comment.