Logo ProcessCore

Path Module

Functions and values

Function or value Description

ARCConfigFolderName

Full Usage: ARCConfigFolderName

Returns: string
Returns: string

AssayDatasetFolderName

Full Usage: AssayDatasetFolderName

Returns: string
Returns: string

AssayFileName

Full Usage: AssayFileName

Returns: string
Returns: string

AssayProtocolsFolderName

Full Usage: AssayProtocolsFolderName

Returns: string
Returns: string

AssaysFolderName

Full Usage: AssaysFolderName

Returns: string
Returns: string

DatamapFileName

Full Usage: DatamapFileName

Returns: string
Returns: string

GitKeepFileName

Full Usage: GitKeepFileName

Returns: string
Returns: string

InvestigationFileName

Full Usage: InvestigationFileName

Returns: string
Returns: string

LICENSEFileName

Full Usage: LICENSEFileName

Returns: string
Returns: string

PathSeperator

Full Usage: PathSeperator

Returns: char
Returns: char

PathSeperatorWindows

Full Usage: PathSeperatorWindows

Returns: char
Returns: char

READMEFileName

Full Usage: READMEFileName

Returns: string
Returns: string

RunCWLFileName

Full Usage: RunCWLFileName

Returns: string
Returns: string

RunFileName

Full Usage: RunFileName

Returns: string
Returns: string

RunYMLFileName

Full Usage: RunYMLFileName

Returns: string
Returns: string

RunsFolderName

Full Usage: RunsFolderName

Returns: string
Returns: string

StudiesFolderName

Full Usage: StudiesFolderName

Returns: string
Returns: string

StudiesProtocolsFolderName

Full Usage: StudiesProtocolsFolderName

Returns: string
Returns: string

StudiesResourcesFolderName

Full Usage: StudiesResourcesFolderName

Returns: string
Returns: string

StudyFileName

Full Usage: StudyFileName

Returns: string
Returns: string

ValidationPackagesYamlFileName

Full Usage: ValidationPackagesYamlFileName

Returns: string
Returns: string

WorkflowCWLFileName

Full Usage: WorkflowCWLFileName

Returns: string
Returns: string

WorkflowFileName

Full Usage: WorkflowFileName

Returns: string
Returns: string

WorkflowsFolderName

Full Usage: WorkflowsFolderName

Returns: string
Returns: string

alternativeLICENSEFileNames

Full Usage: alternativeLICENSEFileNames

Returns: string list
Returns: string list

combine path1 path2

Full Usage: combine path1 path2

Parameters:
    path1 : string
    path2 : string

Returns: string
path1 : string
path2 : string
Returns: string

combineMany paths

Full Usage: combineMany paths

Parameters:
    paths : string seq

Returns: string
paths : string seq
Returns: string

createDirectoryAsync path

Full Usage: createDirectoryAsync path

Parameters:
    path : string

Returns: CrossAsync<unit>
path : string
Returns: CrossAsync<unit>

deleteDirectoryAsync path

Full Usage: deleteDirectoryAsync path

Parameters:
    path : string

Returns: CrossAsync<unit>
path : string
Returns: CrossAsync<unit>

deleteFileAsync path

Full Usage: deleteFileAsync path

Parameters:
    path : string

Returns: CrossAsync<unit>
path : string
Returns: CrossAsync<unit>

deleteFileOrDirectoryAsync path

Full Usage: deleteFileOrDirectoryAsync path

Parameters:
    path : string

Returns: CrossAsync<unit>
path : string
Returns: CrossAsync<unit>

directoryExistsAsync path

Full Usage: directoryExistsAsync path

Parameters:
    path : string

Returns: CrossAsync<bool>
path : string
Returns: CrossAsync<bool>

ensureDirectoryAsync path

Full Usage: ensureDirectoryAsync path

Parameters:
    path : string

Returns: CrossAsync<unit>
path : string
Returns: CrossAsync<unit>

ensureDirectoryOfFileAsync filePath

Full Usage: ensureDirectoryOfFileAsync filePath

Parameters:
    filePath : string

Returns: CrossAsync<unit>
filePath : string
Returns: CrossAsync<unit>

fileExistsAsync path

Full Usage: fileExistsAsync path

Parameters:
    path : string

Returns: CrossAsync<bool>
path : string
Returns: CrossAsync<bool>

getAllFilePathsAsync directoryPath

Full Usage: getAllFilePathsAsync directoryPath

Parameters:
    directoryPath : string

Returns: CrossAsync<string[]>
directoryPath : string
Returns: CrossAsync<string[]>

getSubDirectoriesAsync path

Full Usage: getSubDirectoriesAsync path

Parameters:
    path : string

Returns: CrossAsync<string[]>
path : string
Returns: CrossAsync<string[]>

getSubFilesAsync path

Full Usage: getSubFilesAsync path

Parameters:
    path : string

Returns: CrossAsync<string[]>
path : string
Returns: CrossAsync<string[]>

makeRelative directoryPath path

Full Usage: makeRelative directoryPath path

Parameters:
    directoryPath : string
    path : string

Returns: string

Return the absolute path relative to the directoryPath

directoryPath : string
path : string
Returns: string

moveDirectoryAsync oldPath newPath

Full Usage: moveDirectoryAsync oldPath newPath

Parameters:
    oldPath : string
    newPath : string

Returns: CrossAsync<unit>
oldPath : string
newPath : string
Returns: CrossAsync<unit>

moveFileAsync oldPath newPath

Full Usage: moveFileAsync oldPath newPath

Parameters:
    oldPath : string
    newPath : string

Returns: CrossAsync<unit>
oldPath : string
newPath : string
Returns: CrossAsync<unit>

readFileBinaryAsync path

Full Usage: readFileBinaryAsync path

Parameters:
    path : string

Returns: CrossAsync<byte[]>
path : string
Returns: CrossAsync<byte[]>

readFileTextAsync path

Full Usage: readFileTextAsync path

Parameters:
    path : string

Returns: CrossAsync<string>
path : string
Returns: CrossAsync<string>

readFileXlsx path

Full Usage: readFileXlsx path

Parameters:
    path : string

Returns: FsWorkbook
path : string
Returns: FsWorkbook

readFileXlsxAsync path

Full Usage: readFileXlsxAsync path

Parameters:
    path : string

Returns: CrossAsync<FsWorkbook>
path : string
Returns: CrossAsync<FsWorkbook>

readXlsxBytesAsync bytes

Full Usage: readXlsxBytesAsync bytes

Parameters:
    bytes : byte[]

Returns: CrossAsync<FsWorkbook>
bytes : byte[]
Returns: CrossAsync<FsWorkbook>

renameFileOrDirectoryAsync oldPath newPath

Full Usage: renameFileOrDirectoryAsync oldPath newPath

Parameters:
    oldPath : string
    newPath : string

Returns: CrossAsync<unit>
oldPath : string
newPath : string
Returns: CrossAsync<unit>

seperators

Full Usage: seperators

Returns: char[]
Returns: char[]

split path

Full Usage: split path

Parameters:
    path : string

Returns: string array
path : string
Returns: string array

standardizeSlashes path

Full Usage: standardizeSlashes path

Parameters:
    path : string

Returns: string
path : string
Returns: string

trim path

Full Usage: trim path

Parameters:
    path : string

Returns: string
path : string
Returns: string

writeFileBinaryAsync path bytes

Full Usage: writeFileBinaryAsync path bytes

Parameters:
    path : string
    bytes : byte[]

Returns: CrossAsync<unit>
path : string
bytes : byte[]
Returns: CrossAsync<unit>

writeFileTextAsync path text

Full Usage: writeFileTextAsync path text

Parameters:
    path : string
    text : string

Returns: CrossAsync<unit>
path : string
text : string
Returns: CrossAsync<unit>

writeFileXlsx path wb

Full Usage: writeFileXlsx path wb

Parameters:
path : string
wb : FsWorkbook

writeFileXlsxAsync path wb

Full Usage: writeFileXlsxAsync path wb

Parameters:
Returns: CrossAsync<unit>
path : string
wb : FsWorkbook
Returns: CrossAsync<unit>

writeXlsxBytesAsync wb

Full Usage: writeXlsxBytesAsync wb

Parameters:
Returns: CrossAsync<byte[]>
wb : FsWorkbook
Returns: CrossAsync<byte[]>

Type something to start searching.