Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Full-text search across all frameworks with the Law4Devs TypeScript SDK.
matchContext snippet showing the matched text in context.
query()const results = await client.search.query('data breach notification', {
framework: 'gdpr',
resultType: 'article',
page: 1,
perPage: 20,
});
console.log(`Found ${results.meta.total} matching articles`);
for (const result of results.data) {
console.log(`[${result.type}] ${result.frameworkName} Art. ${result.articleNumber}: ${result.title}`);
console.log(` ...${result.matchContext}...`);
console.log(` ${result.url}`);
}
| Parameter | Type | Default | Description |
|---|---|---|---|
query | string | required | Search terms |
framework | string | — | Filter results to a specific framework slug |
resultType | string | — | Filter by content type: "article", "recital", or "requirement" |
page | number | 1 | Page number |
perPage | number | 20 | Items per page (1–100) |
Promise<Page<SearchResult>>
meta.pages is always 0 for search results. This is an endpoint limitation — use meta.total and links.next to determine if more results exist.iter()for await (const result of client.search.iter('security requirements')) {
console.log(`[${result.type}] ${result.frameworkName} — ${result.title ?? result.requirementType}`);
}
query() (except page, which is managed internally).
Returns AsyncGenerator<SearchResult>
SearchResult| Field | Type | Description |
|---|---|---|
type | string | Result type: "article", "recital", or "requirement" |
frameworkSlug | string | Parent framework slug |
frameworkName | string | Parent framework display name |
articleNumber | number | null | Article number (for article and requirement results) |
recitalNumber | number | null | Recital number (for recital results) |
paragraphRef | string | null | Source paragraph reference |
title | string | null | Article title (for article results) |
requirementType | string | null | Requirement type (for requirement results) |
matchContext | string | Snippet of text surrounding the match |
url | string | Deep link to the matched item in the API |
const results = await client.search.query('legitimate interest');
for (const result of results.data) {
const ref = result.articleNumber
? `Art. ${result.articleNumber}`
: `Recital ${result.recitalNumber}`;
console.log(`${result.frameworkName} ${ref}: ...${result.matchContext}...`);
}
const requirementMatches: SearchResult[] = [];
for await (const result of client.search.iter('incident response', {
resultType: 'requirement',
})) {
requirementMatches.push(result);
}
console.log(`Found ${requirementMatches.length} matching requirements`);
resultType: 'article' with iter() for a simple way to find every article across all frameworks that mentions a specific term — no need to iterate frameworks first.Was this page helpful?