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 6e299c576c
commit e311a149df
21 changed files with 343 additions and 331 deletions

View file

@ -47,7 +47,7 @@ VerbType: RelatedTo, Contains, PartOf, Causes, CreatedBy, etc.
#### **4. Graph Structure**
```typescript
// VERB RELATIONSHIPS CREATE RICH GRAPH
await brain.addVerb(sourceId, targetId, VerbType.Causes, { strength: 0.8 })
await brain.relate(sourceId, targetId, VerbType.Causes, { strength: 0.8 })
```
**Graph-based clustering potential:**

View file

@ -26,8 +26,8 @@ const brain = new BrainyData({
})
// Automatically prevents duplicate entities
await brain.addNoun("Same content", { id: "123" }) // Added
await brain.addNoun("Same content", { id: "123" }) // Skipped (duplicate)
await brain.add("Same content", { id: "123" }) // Added
await brain.add("Same content", { id: "123" }) // Skipped (duplicate)
```
**Benefits:**
@ -85,8 +85,8 @@ const brain = new BrainyData({
})
// Relationships automatically get intelligent scores
await brain.addVerb(user1, product1, "viewed", { timestamp: Date.now() })
await brain.addVerb(user1, product1, "purchased", { timestamp: Date.now() })
await brain.relate(user1, product1, "viewed", { timestamp: Date.now() })
await brain.relate(user1, product1, "purchased", { timestamp: Date.now() })
// Automatically calculates relationship strength based on multiple factors
// Query using intelligent scores
@ -122,7 +122,7 @@ const brain = new BrainyData({
})
// Automatically extracts and registers entities
await brain.addNoun(
await brain.add(
"Apple CEO Tim Cook announced the new iPhone 15 in Cupertino",
{ type: "news" }
)
@ -160,7 +160,7 @@ const brain = new BrainyData({
// Operations are automatically batched
for (let i = 0; i < 10000; i++) {
await brain.addNoun(`Item ${i}`) // Internally batched
await brain.add(`Item ${i}`) // Internally batched
}
// Processes in optimized batches of 100
```
@ -223,7 +223,7 @@ const brain = new BrainyData({
})
// Data automatically compressed/decompressed
await brain.addNoun(largeDocument) // Compressed before storage
await brain.add(largeDocument) // Compressed before storage
const doc = await brain.getNoun(id) // Decompressed on retrieval
```

File diff suppressed because it is too large Load diff

View file

@ -208,7 +208,7 @@ class DynamicBatcher {
// Automatically applied during bulk operations
for (const item of millionItems) {
await brain.addNoun(item) // Internally batched optimally
await brain.add(item) // Internally batched optimally
}
```