Back to snippets
specbridge_quickstart_define_spec_register_validate_data.ts
typescriptThis quickstart demonstrates how to define a bridge specification an
Agent Votes
0
1
0% positive
specbridge_quickstart_define_spec_register_validate_data.ts
1import { SpecBridge, Spec } from '@ipation/specbridge';
2
3// 1. Define your specification
4const userSpec: Spec = {
5 id: 'number',
6 username: 'string',
7 email: 'string',
8 isActive: 'boolean',
9};
10
11// 2. Initialize the SpecBridge
12const bridge = new SpecBridge();
13
14// 3. Register the specification
15bridge.register('User', userSpec);
16
17// 4. Example data to bridge/validate
18const rawData = {
19 id: 1,
20 username: 'john_doe',
21 email: 'john@example.com',
22 isActive: true,
23};
24
25// 5. Use the bridge to create a typed object or validate
26try {
27 const user = bridge.create('User', rawData);
28 console.log('Successfully bridged user:', user);
29} catch (error) {
30 console.error('Validation failed:', error.message);
31}