React with Native

Bringing together React and React Native

GitHub

README

K explore

k-explore (

OperationClassification

TODO: Ensure embedding this will embed the actual docs in my markdown renderer. I guess it might already do so!

TODO: It would be great to learn more about this topic and see if I can make more cross-environment packages. A great use case would be to create a wrapper around the current fs-orm to enable using it at the frontend too.

OperationClassification node-cjs)

exploration functions for exploring files within King OS

Currently has a thin dependency on

get-path

Useful functions to get paths within King OS.

Depends on sdk-operations, which makes it only work inside of a typerepo.

get-path, but this can probably be removed to make this operation more general purpose (and work outside of King OS too)

Api reference
explore()

This is the safe and friendly version of

findFilesRecursively

Explores your files with many possibilities.

NB: this function only searches one basePath, while explore can do multiple

TODO: since this not only finds files but also explores them, naming should be exploreFilesRecursively, probably.

TODO: TextJson[] is a bit weird name for the resulting type interface...

findFilesRecursively

Input
-
Output
📄 explore (exported const)

This is the safe and friendly version of

findFilesRecursively

Explores your files with many possibilities.

NB: this function only searches one basePath, while explore can do multiple

TODO: since this not only finds files but also explores them, naming should be exploreFilesRecursively, probably.

TODO: TextJson[] is a bit weird name for the resulting type interface...

findFilesRecursively

exploreOperationFolders()

find all active operations (folders having package.json but also tsconfig.json)

returns folder path array

Input
config (optional){ basePath?: { },
}
Output
📄 exploreOperationFolders (exported const)

find all active operations (folders having package.json but also tsconfig.json)

returns folder path array

findAllTodoFolderPaths()
Input
basePathstring
Output
📄 findAllTodoFolderPaths (exported const)
pathArrayIsOperation()

Checks if pathArray contains a package.json and a tsconfig.json and thus should be an operation

Handy for cancelRecursionOn in

explore

This is the safe and friendly version of findFilesRecursively

explore

Input
pathArraystring[]
Output{ }
📄 pathArrayIsOperation (exported const)

Checks if pathArray contains a package.json and a tsconfig.json and thus should be an operation

Handy for cancelRecursionOn in

explore

This is the safe and friendly version of findFilesRecursively

explore

determineFileType()

returns the file type or null if it's unknown

Input
-
Outputul / code / data / text
exploreGitRepoFolders()

find all active git folders (folders having git)

Input
-
Output
findAllDocsFolderPaths()

Returns absolute paths for all docs folders (not the files inside)

Input
ignoreOperations (optional)booleanDon't look for docs folders inside of operation folders
Output
findAllPackages()
Input
config (optional){ basePath?: { },
}
Output
📄 determineFileType (exported const)

returns the file type or null if it's unknown

📄 exploreGitRepoFolders (exported const)

find all active git folders (folders having git)

📄 findAllDocsFolderPaths (exported const)

Returns absolute paths for all docs folders (not the files inside)

📄 findAllPackages (exported const)
CLI
Show CLI information (4)
getArgument()
Input
numbernumber
Output
📄 arg1 (unexported const)
📄 arg2 (unexported const)
📄 getArgument (unexported const)
Tests
Show test information(3)
benchmark()
Input
amount (optional)number
Output
📄 benchmark (unexported const)
📄 test (exported const)
Internal
Show internal (11)
exploreMultiple()

DEPRECATED: not sure if we still need it, look up usecases, can prob be replaced now

Input
-
Output
explorePreset()
Input
-
Output
findAllDotGitFolders()
Input
-
Output
findAllFoldersWithName()
Input
config{ basePath: string,
folderName: string,
ignoreOperations?: boolean,
ignoreFolders?: string[],
}
Output
findFilesRecursively()

Explores your files with many possibilities.

NB: this function only searches one basePath, while explore can do multiple

TODO: since this not only finds files but also explores them, naming should be exploreFilesRecursively, probably.

TODO: TextJson[] is a bit weird name for the resulting type interface...

Input
-
Output
📄 exploreMultiple (exported const)

DEPRECATED: not sure if we still need it, look up usecases, can prob be replaced now

📄 explorePreset (exported const)
📄 findAllDotGitFolders (exported const)
📄 findAllFoldersWithName (exported const)
📄 findFilesRecursively (exported const)

Explores your files with many possibilities.

NB: this function only searches one basePath, while explore can do multiple

TODO: since this not only finds files but also explores them, naming should be exploreFilesRecursively, probably.

TODO: TextJson[] is a bit weird name for the resulting type interface...

📄 test (exported const)

json-util

⬅

k-test

➡