@ fresha/ api-tools- core

此软件包包含共享类型定义、函数和类型 其他项目 api-tools 软件包.

安装

$ npm install @fresha/api-tools-core

用法实例

import type { JSONRef } from '@fresha/api-tools-core';

const ref: JSONRef = { $ref: '#/components' };

类型

以下为类型列表. 关于他们的描述,请查阅 src/types.ts。 。 。 .

• Nullable<T>

• CommonMarkString

• URLString

• ParametrisedURLString

• EmailString

• VersionString

• DateTimeString

• MIMETypeString

• HTTPMethod

• HTTPStatusCode

• JSONPrimitive

• JSONValue

• JSONArray

• JSONObject

• JSONObjectRecord

• JSONObjectArray

• JSONPointerString

• JSONRef

• ObjectOrRef<T>

• JSONAPIMeta

• JSONAPILink

• JSONAPIResourceID

• JSONAPIResourceRelationship

• JSONAPIServerResource

• JSONAPIClientResource

• JSONAPIResource

• JSONAPIImplementationInfo

• JSONAPITopLevelLinks

• JSONAPIDataDocument

• JSONAPIError

• JSONAPIErrorDocument

• JSONAPIDocument

• Disposable

类型警卫

以下为警卫名单. 更多信息请改为 src/typeGuards.ts。 。 。 .

• isJSONObject
• isJSONValueArray
• isJSONRef
• isJSONAPIDataDocument
• isJSONAPIErrorDocument

杂项职能

• transformKeysDeep
• camelCase
• camelCaseDeep
• kebabCase
• kebabCaseDeep