setup-dotnet/node_modules/@actions/io
Danny McCormick 1acab72798
New tool cache (#8)
* Consume new tool-cache

* Fix tests

* Fix workflow
2019-07-30 12:53:06 -04:00
..
lib New tool cache (#8) 2019-07-30 12:53:06 -04:00
README.md New tool cache (#8) 2019-07-30 12:53:06 -04:00
package.json Update toolkit version (#3) 2019-06-24 15:15:54 -04:00

README.md

@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>