@apiquest/types
v1.1.0
Published
Shared TypeScript types for ApiQuest
Readme
@apiquest/types
Shared TypeScript type definitions for the ApiQuest ecosystem.
Installation
npm install @apiquest/typesUsage
import type {
Collection,
Request,
Folder,
Environment,
RunOptions,
RunResult,
IProtocolPlugin,
IAuthPlugin,
IValueProviderPlugin
} from '@apiquest/types';Type Exports
- Collection Types: Collection, Request, Folder, CollectionItem, CollectionInfo
- Auth Types: Auth
- Environment: Environment, Variable
- Runtime: RunOptions, RunResult, RuntimeOptions, ExecutionOptions
- Plugins: IProtocolPlugin, IAuthPlugin, IValueProviderPlugin
- Execution: ExecutionContext, ProtocolResponse, ExecutionRecord, TestResult
- Logging: ILogger, LogLevel
- Cookies: ICookieJar, Cookie, CookieSetOptions, CookieJarOptions
Schema
JSON Schema: https://apiquest.net/schemas/collection-v1.0.json
Compatibility
- TypeScript 5.0+
- Used with
@apiquest/fractureand plugin development
Documentation
License
Dual-licensed under AGPL-3.0-or-later and commercial license. See LICENSE for details.
