Interfaces & Types

Atscript provides TypeScript-like syntax with annotations and semantic types.

Interfaces

Basic object structure definition:

export interface User {
    id: string
    name: string
    age: number
    isActive: boolean
}

Nested & Annotations

@mongo.collection 'users'
export interface User {
    id: string
    profile: {
        name: string
        avatar?: string  // Optional
    }
    settings: {
        theme: 'light' | 'dark'
    }
}

Type Aliases

Type aliases carry metadata and work as runtime objects:

@expect.minLength 3
@expect.maxLength 20
export type Username = string

export type Status = 'pending' | 'success' | 'error'
export type ID = string | number

In TypeScript, use them as both types and validators:

import { Username } from './types.as'

const name: Username = 'john_doe'
const validator = Username.validator()

if (validator.validate(input, true)) {
    // input is Username
}

Properties

Optional & Dynamic

export interface Config {
    name: string
    bio?: string                    // Optional
    [*]: string                     // Wildcard - any string props
    [/^x-.*/]: string              // Pattern - props starting with x-
}

Common patterns:

• [/^REACT_APP_.*/] - Environment variables
• [/.*_URL$/] - URL configs
• [/^social_.*/] - Social links

Type References

import { Address } from './address'

export interface User {
    address: Address
    friends: User[]          // Self-reference
    manager?: User          // Optional reference
}

Arrays & Complex Types

export interface Data {
    tags: string[]                      // Array
    matrix: number[][]                  // 2D array
    tuple: [string, number]             // Tuple
    coords: [number, number, number]    // 3-tuple
}

Intersection Types

interface Timestamped {
    createdAt: string
}

interface Post {
    title: string
} & Timestamped  // Has both title and createdAt

Comments

// Single-line comment
/* Multi-line
   comment */

Complete Example

import { Address } from './address'

@mongo.collection 'users'
export interface User {
    @meta.id
    _id: mongo.objectId

    username: string
    email: string.email

    profile: {
        bio?: string
        [/^social_.*/]: string  // social_twitter, social_github, etc.
    }

    addresses: Address[]
    status: 'active' | 'inactive'
    createdAt: string.isoDate
}

export type UserStatus = User['status']  // Derived type

Next Steps

• Imports & Exports - Module system
• Primitives - Semantic types
• Annotations - Metadata system