docs: add deprecation warnings for addNoun and addVerb methods

- Add @deprecated JSDoc tags to TypeScript definitions
- Update all documentation examples to use modern add() and relate() API
- Preserve batch operations (addNouns, addVerbs) as they remain current
- Mark deprecated methods in both source and compiled definitions

Migration guide:
- addNoun(data, type, metadata) → add(data, { nounType: type, ...metadata })
- addVerb(source, target, type, metadata) → relate(source, target, type, metadata)
This commit is contained in:
David Snelling 2025-09-17 10:48:41 -07:00
parent 20a54fbb7e
commit 2128ef5607
21 changed files with 343 additions and 331 deletions

View file

@ -12,7 +12,7 @@ const brain = new BrainyData() // Zero config!
await brain.init()
// Add data (text auto-embeds!)
await brain.addNoun('The future of AI is here', 'content')
await brain.add('The future of AI is here', { nounType: 'content' })
// Search with Triple Intelligence
const results = await brain.find({
@ -295,7 +295,7 @@ Brainy uses its own clean, readable operators:
### Basic Usage
```typescript
// Add data
const id = await brain.addNoun('Quantum computing breakthrough', {
const id = await brain.add('Quantum computing breakthrough', {
category: 'technology',
year: 2024,
importance: 'high'
@ -322,14 +322,14 @@ const articles = await brain.find({
### Creating Knowledge Graphs
```typescript
// Add entities
const ai = await brain.addNoun('Artificial Intelligence', 'concept')
const ml = await brain.addNoun('Machine Learning', 'concept')
const dl = await brain.addNoun('Deep Learning', 'concept')
const ai = await brain.add('Artificial Intelligence', { nounType: 'concept' })
const ml = await brain.add('Machine Learning', { nounType: 'concept' })
const dl = await brain.add('Deep Learning', { nounType: 'concept' })
// Create relationships
await brain.addVerb(ml, ai, 'subset_of')
await brain.addVerb(dl, ml, 'subset_of')
await brain.addVerb(dl, ai, 'enables')
await brain.relate(ml, ai, 'subset_of')
await brain.relate(dl, ml, 'subset_of')
await brain.relate(dl, ai, 'enables')
// Traverse the graph
const aiEcosystem = await brain.find({