Writer functions
writer-functions (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)
Api reference
getFrontmatterSchema()
Gets the frontmatterSchema of any markdown model. This should contain all elements that are required to be in the frontmatter of the markdown
📄 getFrontmatterSchema (exported const)
Gets the frontmatterSchema of any markdown model. This should contain all elements that are required to be in the frontmatter of the markdown
Internal
Show internal (18)
getFileContents()
Gets the contents of a file in the project
Input | | |
---|
projectRelativeFilePath | string | |
Output | | |
getWriterWebPages()
moveFile()
Input | | |
---|
projectRelativePath | string | Can be file only for now |
Output | | |
newFile()
Input | | |
---|
projectRelativeFilePath | string | |
Output | | |
newFolder()
Input | | |
---|
projectRelativeFolderBasePath | string | |
Output | | |
processAssetUpload()
Used for the markdown reader to immediately process a asset upload. If we want to validate this, it would be good to allow a second parameter that checks if you have access to the file
Input | | |
---|
assets | BackendAsset Part of the asset that should be sent to the backend. The rest should frontend-only
Some values are stored, some are not BackendAsset[] | |
Output | | |
renameFilename()
Input | | |
---|
projectRelativeFilePath | string | |
Output | | |
saveFileContents()
Input | | |
---|
projectRelativeFilePath | string | |
Output | | |
📄 getFileContents (exported const)
Gets the contents of a file in the project
📄 getWriterWebPages (exported const)
📄 moveFile (exported const)
📄 newFile (exported const)
📄 newFolder (exported const)
📄 processAssetUpload (exported const)
Used for the markdown reader to immediately process a asset upload. If we want to validate this, it would be good to allow a second parameter that checks if you have access to the file
📄 renameFilename (exported const)
📄 saveFileContents (exported const)