From f1a7c767b6dd24cf05539464de9c93ab51525642 Mon Sep 17 00:00:00 2001
From: doubleface
Date: Mon, 30 Apr 2018 14:15:17 +0200
Subject: [PATCH] doc generation
---
packages/cozy-konnector-libs/docs/api.md | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/packages/cozy-konnector-libs/docs/api.md b/packages/cozy-konnector-libs/docs/api.md
index 290ba04b9..24609189c 100644
--- a/packages/cozy-konnector-libs/docs/api.md
+++ b/packages/cozy-konnector-libs/docs/api.md
@@ -75,7 +75,6 @@ return filterData(documents, 'io.cozy.height', {
This function will soon move to a dedicated service. You should not use it.
The goal of this function is to find links between bills and bank operations.
-
mkdirp
Creates a directory and its missing ancestors as needed.
Options :
@@ -93,7 +92,8 @@ await mkdirp('/qux', 'qux2/qux3', 'qux4') // Creates /qu
The function will automatically add a leading slash when missing:
await mkdirp('foo', 'bar') // Creates /foo, then /foo/bar
-
+
+
normalizeFilename
Returns the given name, replacing characters that could be an issue when
used in a filename with spaces.
@@ -115,7 +115,6 @@ character in the given name.
const filename = normalizeFilename('*foo/bar: <baz> \\"qux"\t???', '.txt')
// `filename` === `foo bar baz qux.txt`
-
requestFactory
@@ -303,6 +302,9 @@ fetch account information for your connector.
SAVE_FILE_FAILED : String
There was a problem while saving a file
+DISK_QUOTA_EXCEEDED : String
+Could not save a file to the cozy because of disk quota exceeded
+
## Functions
@@ -443,6 +445,7 @@ The function will automatically add a leading slash when missing:
```javascript
await mkdirp('foo', 'bar') // Creates /foo, then /foo/bar
+```
@@ -470,7 +473,6 @@ const { normalizeFilename } = require('cozy-konnector-libs')
const filename = normalizeFilename('*foo/bar: \\"qux"\t???', '.txt')
// `filename` === `foo bar baz qux.txt`
-
```
@@ -790,6 +792,12 @@ There was a problem while downloading a file
## SAVE_FILE_FAILED : String
There was a problem while saving a file
+**Kind**: global constant
+
+
+## DISK_QUOTA_EXCEEDED : String
+Could not save a file to the cozy because of disk quota exceeded
+
**Kind**: global constant