Suite of AT Protocol TypeScript libraries built on web standards
21
fork

Configure Feed

Select the types of activity you want to include in your feed.

at main 35 lines 866 B view raw
1/** 2 * # AT Protocol Lexicon Validation Utility 3 * 4 * This module provides utilities for validating and working with AT Protocol lexicons 5 * in TypeScript. 6 * 7 * @example Validate a lexicon 8 * ```typescript 9 * import { Lexicon } from "@atp/lexicon"; 10 * 11 * // create your lexicons collection 12 * const lex = new Lexicons() 13 * 14 * // add your lexicons 15 * lex.add({ 16 * lex: 1, 17 * id: 'com.example.post', 18 * defs: { 19 * // ... 20 * } 21 * }) 22 * 23 * // validate 24 * lex.assertValidRecord('com.example.record', {$type: 'com.example.record', ...}) 25 * lex.assertValidXrpcParams('com.example.query', {...}) 26 * lex.assertValidXrpcInput('com.example.procedure', {...}) 27 * lex.assertValidXrpcOutput('com.example.query', {...}) 28 * ``` 29 * 30 * @module 31 */ 32export * from "./types.ts"; 33export * from "./lexicons.ts"; 34export * from "./blob-refs.ts"; 35export * from "./serialize.ts";