1
0
Fork 0
mirror of https://github.com/actions/setup-python.git synced 2024-12-23 20:55:36 +00:00
setup-python/node_modules/@actions/io
Stephen Franceschelli 7dc6a07f36 Fix build. (#8)
* Fix.

* Husky commit correct node modules
2019-07-30 13:19:56 -04:00
..
lib Initial pass 2019-06-26 21:12:00 -04:00
package.json Fix build. (#8) 2019-07-30 13:19:56 -04:00
README.md Initial pass 2019-06-26 21:12:00 -04:00

@actions/io

Core functions for cli filesystem scenarios

Usage

/**
 * Copies a file or folder.
 * 
 * @param     source    source path
 * @param     dest      destination path
 * @param     options   optional. See CopyOptions.
 */
export function cp(source: string, dest: string, options?: CopyOptions): Promise<void>

/**
 * Remove a path recursively with force
 * 
 * @param     path     path to remove
 */
export function rmRF(path: string): Promise<void>

/**
 * Make a directory.  Creates the full path with folders in between
 * 
 * @param     p       path to create
 * @returns   Promise<void>
 */
export function mkdirP(p: string): Promise<void>

/**
 * Moves a path.
 *
 * @param     source    source path
 * @param     dest      destination path
 * @param     options   optional. See CopyOptions.
 */
export function mv(source: string, dest: string, options?: CopyOptions): Promise<void>

/**
 * Returns path of a tool had the tool actually been invoked.  Resolves via paths.
 * 
 * @param     tool              name of the tool
 * @param     options           optional. See WhichOptions.
 * @returns   Promise<string>   path to tool
 */
export function which(tool: string, options?: WhichOptions): Promise<string>