Skip to content

Commit

Permalink
[WSO2-Release] [Release 2.0.5] update documentation for release 2.0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
@wso2-jenkins-bot
wso2-jenkins-bot committed Dec 12, 2019
1 parent 51fcff8 commit 14b447f
Show file tree
Hide file tree
Showing 5 changed files with 1,097 additions and 49 deletions.
32 changes: 16 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,25 @@ For information on <a target="_blank" href="https://siddhi.io/">Siddhi</a> and i

## Latest API Docs

Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4">2.0.4</a>.
Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5">2.0.5</a>.

## Features

* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#isdirectory-function">isDirectory</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function checks for a given file path points to a directory</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#isexist-function">isExist</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function checks whether a file or a folder exists in a given path</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#isfile-function">isFile</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function checks for a given file path points to a file</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#lastmodifiedtime-function">lastModifiedTime</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Checks for the last modified time for a given file path</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#size-function">size</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function checks for a given file's size</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#archive-stream-function">archive</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Archives files and folders as a zip or in tar format that are available in the given file uri.<br></p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#copy-stream-function">copy</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function performs copying file from one directory to another.<br></p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#create-stream-function">create</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Create a file or a folder in the given location</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#delete-stream-function">delete</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Deletes file/files in a particular path</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#move-stream-function">move</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function performs copying file from one directory to another.<br></p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#search-stream-function">search</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Searches files in a given folder and lists.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#searchinarchive-stream-function">searchInArchive</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#unarchive-stream-function">unarchive</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function decompresses a given file</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#file-sink">file</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#sink">Sink</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">File Sink can be used to publish (write) event data which is processed within siddhi to files. <br>Siddhi-io-file sink provides support to write both textual and binary data into files<br></p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.4/#file-source">file</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#source">Source</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">File Source provides the functionality for user to feed data to siddhi from files. Both text and binary files are supported by file source.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#isdirectory-function">isDirectory</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function checks for a given file path points to a directory</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#isexist-function">isExist</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function checks whether a file or a folder exists in a given path</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#isfile-function">isFile</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function checks for a given file path points to a file</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#lastmodifiedtime-function">lastModifiedTime</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Checks for the last modified time for a given file path</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#size-function">size</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function checks for a given file's size</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#archive-stream-function">archive</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Archives files and folders as a zip or in tar format that are available in the given file uri.<br></p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#copy-stream-function">copy</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function performs copying file from one directory to another.<br></p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#create-stream-function">create</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Create a file or a folder in the given location</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#delete-stream-function">delete</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Deletes file/files in a particular path</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#move-stream-function">move</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function performs copying file from one directory to another.<br></p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#search-stream-function">search</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Searches files in a given folder and lists.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#searchinarchive-stream-function">searchInArchive</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This.</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#unarchive-stream-function">unarchive</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-function">Stream Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function decompresses a given file</p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#file-sink">file</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#sink">Sink</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">File Sink can be used to publish (write) event data which is processed within siddhi to files. <br>Siddhi-io-file sink provides support to write both textual and binary data into files<br></p></p></div>
* <a target="_blank" href="https://siddhi-io.github.io/siddhi-io-file/api/2.0.5/#file-source">file</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#source">Source</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">File Source provides the functionality for user to feed data to siddhi from files. Both text and binary files are supported by file source.</p></p></div>

## Dependencies

Expand Down
Loading

0 comments on commit 14b447f

Please sign in to comment.