turbo-sync/types.js

29 lines
733 B
JavaScript
Raw Normal View History

2024-10-16 04:44:48 +00:00
// @ts-check
/**
* @typedef {TurboSyncConfigObject[]} TurboSyncConfigArray
*/
/**
* @typedef {object} TurboSyncConfigObject
* @property {string} [title]
* @property {string[] | TurboSyncFileObject[]} [files]
* @property {string[] | TurboSyncFileObject[]} [folders]
* @property {TurboSyncOptions} [options]
*/
/**
* @typedef {object} TurboSyncFileObject
* @property {string} path
* @property {string} [host]
* @property {string} [user]
* @property {string} [ssh_key]
* @property {number} [interval]
*/
/**
* @typedef {object} TurboSyncOptions
* @property {boolean} [delete] - Should files removed be deleted in all destinations?
* @property {string[]} [exclude] - Patterns that should be ignored. Eg "*.log"
*/