@dbs-portal/module-docs
v1.0.0
Published
Document management system with collaborative editing, version control, and search functionality
Readme
@dbs-portal/module-docs
Document management system with collaborative editing, version control, and search functionality
Installation
yarn add @dbs-portal/module-docsUsage
import { Docs, createDocs } from '@dbs-portal/module-docs'
// Use the default instance
const result = await defaultDocs.process(data)
// Or create a custom instance
const customDocs = createDocs({
enabled: true,
debug: true,
})
const customResult = await customDocs.process(data)API Reference
Classes
Docs
Main class for @dbs-portal/module-docs functionality.
Constructor:
new Docs(config?: DocsConfig)
Methods:
getConfig(): DocsConfig- Get current configurationprocess<T>(data: T): Promise<DocsResult<T>>- Process data
Functions
createDocs(config?)
Factory function to create a new Docs instance.
Development
# Build the package
yarn build
# Run tests
yarn test
# Type checking
yarn type-check
# Linting
yarn lint