add example for tls option in constructor + fix typo

JiPaix · Oct 14, 2021 · cece9fa · cece9fa
1 parent 863b4fa
commit cece9fa
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/connect.ts b/src/connect.ts
@@ -66,7 +66,12 @@ export interface ParamsIRC {
    */
   verbose?: boolean
   /**
-   * Enable TSL/SSL
+   * Enable TLS/SSL
+   * @default `false`
+   * @example
+   * ```js
+   * params.tls = true
+   * ```
    */
    tls?: boolean
 }