@apple/cktool.api.base
v1.3.2
Published
Apple CKTool JS 'base' API
Downloads
314
Keywords
Readme
CKTool JS - "base" API Package
This package is part of the CKTool JS JavaScript client library suite and includes operations and TypeScript types related to "base".
Each operation has a corresponding function that
returns a CancellablePromise
that resolves
if successful and rejects if the operation fails.
Don't use this package on its own. It is automatically pulled
in when you include @apple/cktool.database
in your package.json
dependencies.
Getting Started
See Apple Developer Documentation for more details on how to get started using CKTool JS.
API Promise Mixin
BasePromisesApiMixin
Don't use this mixin directly. Instead, use PromisesApi
from @apple/cktool.database
.
Methods
The following methods are added by the mixin.
getContainers
Fetches containers for a team.getTeams
Fetches a list of teams the current user is in.
TypeScript Types
AuthenticationRequiredError
CKDatabaseType
CKEnvironment
Container
ContainersResponse
ContainersSortByField
RequestError
SortDirection
Team
TeamsResponse