UNPKG

@unito/integration-api

Version:

The Unito Integration API

80 lines (79 loc) • 3.8 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
import * as Api from './types.js'; /** * Checks if the input is a record<unknown, unknown> * @param potentialObject - The value to check. * @returns True if the value is a record, false otherwise. */ export declare function isObject(potentialObject: unknown): potentialObject is Record<string, unknown>; /** * Checks if the input is a string. * @param potentialString - The value to check. * @returns True if the value is a string, false otherwise. */ export declare function isString(potentialString: unknown): potentialString is string; /** * Checks if the input is undefined. * @param potentialUndefined - The value to check. * @returns True if the value is undefined, false otherwise. */ export declare function isUndefined(potentialUndefined: unknown): potentialUndefined is undefined; /** * Checks if the input is an Api.ItemSummary object. * @param potentialItemSummary - The value to check. * @returns True if the value is an ItemSummary, false otherwise. */ export declare function isItemSummary(potentialItemSummary: unknown): potentialItemSummary is Api.ItemSummary; /** * Checks if the input is an Api.Item object. * @param potentialItem - The value to check. * @returns True if the value is an Item, false otherwise. */ export declare function isItem(potentialItem: unknown): potentialItem is Api.Item; /** * Checks if the input is an Api.ReferenceRelation object. * @param potentialReferenceRelation - The value to check. * @returns True if the value is a ReferenceRelation, false otherwise. */ export declare function isReferenceRelation(potentialReferenceRelation: unknown): potentialReferenceRelation is Api.ReferenceRelation; /** * Checks if the input is an Api.RelationSummary object. * @param potentialRelationSummary - The value to check. * @returns True if the value is a RelationSummary, false otherwise. */ export declare function isRelationSummary(potentialRelationSummary: unknown): potentialRelationSummary is Api.RelationSummary; /** * Checks if the input is an Api.Relation object. * @param potentialRelation - The value to check. * @returns True if the value is a Relation, false otherwise. */ export declare function isRelation(potentialRelation: unknown): potentialRelation is Api.Relation; /** * Checks if the input is an Api.RelationSchema object. * @param potentialRelationSchema - The value to check. * @returns True if the value is a RelationSchema, false otherwise. */ export declare function isRelationSchema(potentialRelationSchema: unknown): potentialRelationSchema is Api.RelationSchema; /** * Checks if the input is an Api.RelationSchema object or the string '__self'. * @param potentialRelationSchema - The value to check. * @returns True if the value is a RelationSchema or '__self', false otherwise. */ export declare function isRelationSchemaOrSelf(potentialRelationSchemaOrSelf: unknown): potentialRelationSchemaOrSelf is Api.RelationSchema | '__self'; /** * Checks if the input is an Api.FieldValueType. * @param potentialFieldValueType - The value to check. * @returns True if the value is a FieldValueType, false otherwise. */ export declare function isFieldValueType(potentialFieldValueType: unknown): potentialFieldValueType is Api.FieldValueType; /** * Checks if the input is an Api.Semantic value. * @param potentialSemantic - The value to check. * @returns True if the value is a Semantic, false otherwise. */ export declare function isSemantic(potentialSemantic: unknown): potentialSemantic is Api.Semantic; /** * Checks if the input is an Api.FieldSchema object. * @param potentialFieldSchema - The value to check. * @returns True if the value is a FieldSchema, false otherwise. */ export declare function isFieldSchema(potentialFieldSchema: unknown): potentialFieldSchema is Api.FieldSchema;