React with Native

Bringing together React and React Native

GitHub

README

Database

database (

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)

Operation that can be used within any typerepo to interact with the

fs-orm

ORM that lets you create a database with models that are stored on the file system in multiple formats that are easy to understand and well structured.

fs-orm (typebase) database. Relies on sdk-db (where your models should be summarized)

Api reference
📄 db (exported const)
getMergedQueryConfig()
Input
modelNameSelfSprintReview / TodoFile / TodoOffer / AuthorizationModel / Device / Group / PageVisit / PaymentCoupon / PaymentEvent / PaymentPlan / PaymentSubscription / PeerMessage / Person / Persona / PersonInformation / PersonInformationValue / PersonPlatformConnection / Platform / RecurringReminder / Interest / MediaChannel / MediaCredentail / MediaPost / Postable / BundleConfig / Dataset / FunctionExecution / Operation / SocialMediaCallToAction / TsBuildError / TsComment / TsConfig / TsExport / TsFunction / TsImport / TsInterface / TsLintWarning / TsVariable / TypescriptFile / WebMarkdownFile / WebsiteCallToAction / Address / Area / City / Country / Location / KvmdWord / MarkdownWord / NepaliEnglishTranslationMatrix / Statement / TokiPonaMatrix / Translation / Word / WordCategory / WordCombination / WordMatrix / SlugModelType / AppDeveloper / Assignment / Bag / Calendar / Deliverable / Diary / Feeling / FeelingLog / Folder / Host / Inventory / Item / ItemCategory / KvmdShortcut / Label / Light / Listing / LoginCredential / Material / MessagePreset / PersonalCarbonFootprintProfile / ProgressReport / Question / Reservation / Resource / Shit / ShitLog / ShoppingList / Shortcut / Student / Student2 / TaskError / Trackable / User / UserCredential / Artist / PlayCategory / PlayItem / PlayList / PlaySchedule / RelationModelType / JeepType / LocationType / OperationConfig / OperationIndex / PackageJson / Activity / CompanyRequirement / CompanySize / CompanyType / Company / ContactInformation / Contribution / EsgMetric / ProductCategory / Product / ProofState / Proof / SustainabilityPlan / ValueChainPhase
Output
📄 getMergedQueryConfig (exported const)
CLI
Show CLI information (8)
getCli()
Input
-
Output
removeCli()
Input
-
Output
updateCli()
Input
-
Output
upsertCli()
Input
-
Output
📄 getCli (exported const)
📄 removeCli (exported const)
📄 updateCli (exported const)
📄 upsertCli (exported const)
Tests
Show test information(14)
get()
Input
-
Output
main()
Input
-
Output
migration()
Input
-
Output
set()

Can set a markdown item into a subfolder in the db model folder

Input
-
Output
testPerformance()
Input
-
Output
test()
Input
-
Output
upsert()
Input
-
Output
📄 get (unexported const)
📄 main (unexported const)
📄 migration (unexported const)
📄 set (unexported const)

Can set a markdown item into a subfolder in the db model folder

📄 testPerformance (exported const)
📄 test (unexported const)
📄 upsert (unexported const)
Internal
Show internal (33)
generateCsvInstance()
Input
-
Output
generateJsonSingleInstance()
Input
-
Output
generateKvmdInstance()
Input
-
Output
generateMarkdownInstance()
Input
-
Output
generateSlugTestModel()
Input
-
Output
getCli()
Input
-
Output
randomName()
Input
-
OutputString
removeCli()
Input
-
Output
runModelEndToEndTest()

NB: we can't do a maketest because this thing relies on logging and we don't want to auto-run it

Input
-
Output
testOperationModels()

Test if it can find all OperationIndex, OperationConfig, PackageJson,

TsConfig

would be nice if we have a type interface for this, just like package.json for now just type the stuff we need

TsConfig

Input
-
Output
testPerformance()
Input
-
Output
updateCli()
Input
-
Output
upsertCli()
Input
-
Output
🔸 CsvTestModel

csv model

Properties:

NameTypeDescription
createdAtnumber
updatedAtnumber
deletedAtnumber
createdFirstAtnumber
operationNamenull
projectRelativePathstring
operationRelativePath (optional)string
idstring
namestring
descriptionstring
agenumber
🔸 DefaultTestModel

jsonMultiple model

Properties:

NameTypeDescription
createdAtnumber
updatedAtnumber
deletedAtnumber
createdFirstAtnumber
operationNamenull
projectRelativePathstring
operationRelativePath (optional)string
idstring
categoryStackCalculated (optional)array
namestring
descriptionstring
markdownstring
specialboolean
🔸 KvmdTestModel

keyValueMarkdown model

Properties:

NameTypeDescription
idstring
namestring
slugstring
value (optional)string
commentstring
operationNamenull
projectRelativePathstring
operationRelativePath (optional)string
categoryStackCalculatedarray
isHeaderCalculatedboolean
🔸 MarkdownTestModel

markdown model

Properties:

NameTypeDescription
createdAtnumber
updatedAtnumber
deletedAtnumber
createdFirstAtnumber
operationNamenull
projectRelativePathstring
operationRelativePath (optional)string
idstring
namestring
slugstring
markdownstring
categoryStackCalculatedarray
stringAstring
stringBstring
stringCstring
agenumber
yesboolean
canBeNullstring
canBeUndefined (optional)string
🔸 SlugTestModel

jsonMultiple model

Properties:

NameTypeDescription
slugstring
namestring
languagestring
createdAtnumber
updatedAtnumber
deletedAtnumber
createdFirstAtnumber
operationNamenull
projectRelativePathstring
operationRelativePath (optional)string
idstring
categoryStackCalculated (optional)array
descriptionstring
markdownstring
specialboolean
🔹 TestModels

Properties:

NameTypeDescription
CsvTestModelobject
KeyValueMarkdownTestModelobject
MarkdownTestModelobject
JsonMultipleTestModelobject
DefaultTestModelobject
TsConfigobject
📄 generateCsvInstance (exported const)
📄 generateJsonSingleInstance (exported const)
📄 generateKvmdInstance (exported const)
📄 generateMarkdownInstance (exported const)
📄 generateSlugTestModel (exported const)
📄 getCli (exported const)
📄 randomName (exported const)
📄 removeCli (exported const)
📄 runModelEndToEndTest (exported const)

NB: we can't do a maketest because this thing relies on logging and we don't want to auto-run it

📄 testDb (exported const)

a db is created with models from all different db storage methods

📄 testOperationModels (exported const)

Test if it can find all OperationIndex, OperationConfig, PackageJson,

TsConfig

would be nice if we have a type interface for this, just like package.json for now just type the stuff we need

TsConfig

📄 testPerformance (exported const)
📄 updateCli (exported const)
📄 upsertCli (exported const)