@nishans/core / Exports

@nishans/core

Index

Classes

• Block
• BoardView
• CalendarView
• Collection
• CollectionBlock
• CollectionView
• CollectionViewPage
• GalleryView
• ListView
• NotionUser
• Operations
• Page
• SchemaUnit
• Space
• SpaceView
• TableView
• TimelineView
• UserRoot
• UserSettings
• View
• default

Interfaces

• BoardViewCreateInput
• CalendarViewCreateInput
• GalleryViewCreateInput
• IAudioInput
• IBreadcrumbInput
• IBulletedListInput
• ICalloutInput
• ICodeInput
• ICodepenInput
• ICollectionBlockInput
• ICollectionViewInput
• ICollectionViewPageInput
• ICollectionViewPageUpdateInput
• IColumnListInput
• IDividerInput
• IDriveInput
• IEmbedInput
• IEquationInput
• IFactoryInput
• IFigmaInput
• IFileInput
• IGistInput
• IHeaderInput
• IImageInput
• ILinkToPageInput
• ILinkedDBInput
• IMapsInput
• INumberedListInput
• IPageCreateInput
• IPageUpdateInput
• IQuoteInput
• ISubHeaderInput
• ISubSubHeaderInput
• ITBlock
• ITOCInput
• ITPage
• ITSchemaUnit
• ITView
• ITextInput
• ITodoInput
• IToggleInput
• ITweetInput
• IVideoInput
• IViewCreateInput
• IViewFilterCreateInput
• IViewFilterUpdateInput
• IWebBookmarkInput
• ListViewCreateInput
• NishanArg
• TableViewCreateInput
• TimelineViewCreateInput

Type aliases

• AbsFunctionCreateInput
• AndFunctionCreateInput
• CbrtFunctionCreateInput
• CeilFunctionCreateInput
• CheckboxIfFunctionCreateInput
• ConcatFunctionCreateInput
• ContainsFunctionCreateInput
• DateAddFunctionCreateInput
• DateBetweenFunctionCreateInput
• DateFunctionCreateInput
• DateIfFunctionCreateInput
• DateSubtractFunctionCreateInput
• DayFunctionCreateInput
• DivideFunctionCreateInput
• ElementType
• EmptyFunctionCreateInput
• EndFunctionCreateInput
• EqualFunctionCreateInput
• ExpFunctionCreateInput
• FilterType
• FilterTypes
• FloorFunctionCreateInput
• FormatDateFunctionCreateInput
• FormatFunctionCreateInput
• FormulaSchemaUnitInput
• FromTimestampFunctionCreateInput
• HourFunctionCreateInput
• ICollectionUpdateInput
• INotionUserUpdateInput
• ISchemaAggregationMap
• ISchemaAggregationMapValue
• ISchemaFiltersMap
• ISchemaFiltersMapValue
• ISchemaFormatMap
• ISchemaFormatMapValue
• ISchemaMap
• ISchemaMapValue
• ISchemaSortsMap
• ISchemaSortsMapValue
• ISpaceUpdateInput
• ISpaceViewUpdateInput
• IUserSettingsUpdateInput
• JoinFunctionCreateInput
• LargerEqFunctionCreateInput
• LargerFunctionCreateInput
• LengthFunctionCreateInput
• LnFunctionCreateInput
• Log10FunctionCreateInput
• Log2FunctionCreateInput
• Logger
• MaxFunctionCreateInput
• MinFunctionCreateInput
• MinuteFunctionCreateInput
• ModFunctionCreateInput
• MonthFunctionCreateInput
• MultiplyFunctionCreateInput
• NotFunctionCreateInput
• NowFunctionCreateInput
• NumberAddFunctionCreateInput
• NumberIfFunctionCreateInput
• OrFunctionCreateInput
• PowFunctionCreateInput
• Predicate
• ReplaceAllFunctionCreateInput
• ReplaceFunctionCreateInput
• RepositionParams
• RoundFunctionCreateInput
• SchemaFormalPropertiesUpdateInput
• SignFunctionCreateInput
• SliceFunctionCreateInput
• SmallerEqFunctionCreateInput
• SmallerFunctionCreateInput
• SqrtFunctionCreateInput
• StartFunctionCreateInput
• SubtractFunctionCreateInput
• TAdvancedBlockInput
• TAggregationsCreateInput
• TAggregationsUpdateInput
• TBasicBlockInput
• TBlockCreateInput
• TBlockInput
• TCheckboxFunctionCreateInput
• TCheckboxResultType
• TCollectionBlockInput
• TDateFunctionCreateInput
• TDateResultType
• TEmbedBlockInput
• TFormulaCreateInput
• TMediaBlockInput
• TMethodType
• TNumberFunctionCreateInput
• TNumberResultType
• TResultType
• TSchemaUnitInput
• TSortCreateInput
• TSortUpdateInput
• TTextFunctionCreateInput
• TTextResultType
• TViewCreateInput
• TViewFilterCreateInput
• TViewFilterUpdateInput
• TViewSchemaUnitsCreateInput
• TestFunctionCreateInput
• TextAddFunctionCreateInput
• TextIfFunctionCreateInput
• TimestampFunctionCreateInput
• ToNumberFunctionCreateInput
• UnaryMinusFunctionCreateInput
• UnaryPlusFunctionCreateInput
• UnequalFunctionCreateInput
• UpdateType
• UpdateTypes
• YearFunctionCreateInput

Variables

• Operation
• TCollectionUpdateKeys
• TNotionUserUpdateKeys
• TSpaceUpdateKeys
• TSpaceViewUpdateKeys
• TUserSettingsUpdateKeys

Functions

• createBlockClass
• createBlockMap
• createCollection
• createPageMap
• createSchemaUnitMap
• createShortId
• createViewMap
• createViews
• detectChildData
• error
• formulateResultTypeFromSchemaType
• generateId
• getAggregationsMap
• getFiltersMap
• getFormatPropertiesMap
• getSchemaMap
• getSortsMap
• initializeViewAggregations
• initializeViewFilters
• initializeViewSorts
• iterateAndDeleteChildren
• iterateAndGetChildren
• iterateAndUpdateChildren
• nestedContentPopulate
• parseFormula
• populateFilters
• positionChildren
• slugify
• validateUUID
• warn

Type aliases

AbsFunctionCreateInput

Ƭ AbsFunctionCreateInput: IFunctionCreateInput<abs, TNumberResultType>

Defined in: core/types/formula.ts:102

---

AndFunctionCreateInput

Ƭ AndFunctionCreateInput: IFunctionCreateInput<and, Tuple2<TCheckboxResultType>>

Defined in: core/types/formula.ts:82

---

CbrtFunctionCreateInput

Ƭ CbrtFunctionCreateInput: IFunctionCreateInput<cbrt, TNumberResultType>

Defined in: core/types/formula.ts:103

---

CeilFunctionCreateInput

Ƭ CeilFunctionCreateInput: IFunctionCreateInput<ceil, TNumberResultType>

Defined in: core/types/formula.ts:104

---

CheckboxIfFunctionCreateInput

Ƭ CheckboxIfFunctionCreateInput: { args: Tuple12<TCheckboxResultType, TCheckboxResultType> ; function: if ; result_type: checkbox }

Type declaration:

Name	Type
args	Tuple12<TCheckboxResultType, TCheckboxResultType>
function	if
result_type	checkbox

Defined in: core/types/formula.ts:37

---

ConcatFunctionCreateInput

Ƭ ConcatFunctionCreateInput: IFunctionCreateInput<concat, Tuple2<TTextResultType>>

Defined in: core/types/formula.ts:75

---

ContainsFunctionCreateInput

Ƭ ContainsFunctionCreateInput: IFunctionCreateInput<contains, Tuple2<TTextResultType>>

Defined in: core/types/formula.ts:96

---

DateAddFunctionCreateInput

Ƭ DateAddFunctionCreateInput: IFunctionCreateInput<dateAdd, [TDateResultType, TNumberResultType, TDateConstantValueType]>

Defined in: core/types/formula.ts:117

---

DateBetweenFunctionCreateInput

Ƭ DateBetweenFunctionCreateInput: IFunctionCreateInput<dateBetween, Tuple12<TDateResultType, TDateConstantValueType>>

Defined in: core/types/formula.ts:125

---

DateFunctionCreateInput

Ƭ DateFunctionCreateInput: IFunctionCreateInput<date, TDateResultType>

Defined in: core/types/formula.ts:135

---

DateIfFunctionCreateInput

Ƭ DateIfFunctionCreateInput: { args: Tuple12<TCheckboxResultType, TDateResultType> ; function: if ; result_type: date }

Type declaration:

Name	Type
args	Tuple12<TCheckboxResultType, TDateResultType>
function	if
result_type	date

Defined in: core/types/formula.ts:43

---

DateSubtractFunctionCreateInput

Ƭ DateSubtractFunctionCreateInput: IFunctionCreateInput<dateSubtract, [TDateResultType, TNumberResultType, TDateConstantValueType]>

Defined in: core/types/formula.ts:121

---

DayFunctionCreateInput

Ƭ DayFunctionCreateInput: IFunctionCreateInput<day, TDateResultType>

Defined in: core/types/formula.ts:134

---

DivideFunctionCreateInput

Ƭ DivideFunctionCreateInput: IFunctionCreateInput<divide, Tuple2<TNumberResultType>>

Defined in: core/types/formula.ts:90

---

ElementType

Ƭ ElementType<T>: T extends ReadonlyArray<infer ElementType> ? ElementType : never

Type parameters:

Name	Type
T	ReadonlyArray<unknown>

Defined in: core/types/utils.ts:1

---

EmptyFunctionCreateInput

Ƭ EmptyFunctionCreateInput: IFunctionCreateInput<empty, TResultType>

Defined in: core/types/formula.ts:101

---

EndFunctionCreateInput

Ƭ EndFunctionCreateInput: IFunctionCreateInput<end, TDateResultType>

Defined in: core/types/formula.ts:116

---

EqualFunctionCreateInput

Ƭ EqualFunctionCreateInput: IFunctionCreateInput<equal, Tuple2AnyResultType>

Defined in: core/types/formula.ts:49

---

ExpFunctionCreateInput

Ƭ ExpFunctionCreateInput: IFunctionCreateInput<exp, TNumberResultType>

Defined in: core/types/formula.ts:105

---

FilterType

Ƭ FilterType<T>: undefined | string | Predicate<T>

Type parameters:

Name
T

Defined in: core/types/nishan.ts:21

---

FilterTypes

Ƭ FilterTypes<T>: undefined | string[] | Predicate<T>

Type parameters:

Name
T

Defined in: core/types/nishan.ts:20

---

FloorFunctionCreateInput

Ƭ FloorFunctionCreateInput: IFunctionCreateInput<floor, TNumberResultType>

Defined in: core/types/formula.ts:106

---

FormatDateFunctionCreateInput

Ƭ FormatDateFunctionCreateInput: IFunctionCreateInput<formatDate, [TDateResultType, TTextResultType]>

Defined in: core/types/formula.ts:129

---

FormatFunctionCreateInput

Ƭ FormatFunctionCreateInput: IFunctionCreateInput<format, TResultType>

Defined in: core/types/formula.ts:81

---

FormulaSchemaUnitInput

Ƭ FormulaSchemaUnitInput: { formula: TFormulaCreateInput ; name: string ; type: formula }

Type declaration:

Name	Type
formula	TFormulaCreateInput
name	string
type	formula

Defined in: core/types/schema.ts:17

---

FromTimestampFunctionCreateInput

Ƭ FromTimestampFunctionCreateInput: IFunctionCreateInput<fromTimestamp, TNumberResultType>

Defined in: core/types/formula.ts:131

---

HourFunctionCreateInput

Ƭ HourFunctionCreateInput: IFunctionCreateInput<hour, TDateResultType>

Defined in: core/types/formula.ts:133

---

ICollectionUpdateInput

Ƭ ICollectionUpdateInput: Partial<Pick<ICollection, ElementType<typeof TCollectionUpdateKeys>>>

Defined in: core/types/block.ts:282

---

INotionUserUpdateInput

Ƭ INotionUserUpdateInput: Partial<Pick<INotionUser, ElementType<typeof TNotionUserUpdateKeys>>>

Defined in: core/types/block.ts:284

---

ISchemaAggregationMap

Ƭ ISchemaAggregationMap: Map<string, ISchemaAggregationMapValue>

Defined in: core/types/schema.ts:27

---

ISchemaAggregationMapValue

Ƭ ISchemaAggregationMapValue: { aggregation: ViewAggregations ; schema_id: string } & TSchemaUnit

Defined in: core/types/schema.ts:26

---

ISchemaFiltersMap

Ƭ ISchemaFiltersMap: Map<string, ISchemaFiltersMapValue>

Defined in: core/types/schema.ts:33

---

ISchemaFiltersMapValue

Ƭ ISchemaFiltersMapValue: { filters: IViewFilter[filters] ; schema_id: string } & TSchemaUnit

Defined in: core/types/schema.ts:32

---

ISchemaFormatMap

Ƭ ISchemaFormatMap: Map<string, ISchemaFormatMapValue>

Defined in: core/types/schema.ts:36

---

ISchemaFormatMapValue

Ƭ ISchemaFormatMapValue: { format: ViewFormatProperties ; schema_id: string } & TSchemaUnit

Defined in: core/types/schema.ts:35

---

ISchemaMap

Ƭ ISchemaMap: Map<string, ISchemaMapValue>

Defined in: core/types/schema.ts:24

---

ISchemaMapValue

Ƭ ISchemaMapValue: { schema_id: string } & TSchemaUnit

Defined in: core/types/schema.ts:23

---

ISchemaSortsMap

Ƭ ISchemaSortsMap: Map<string, ISchemaSortsMapValue>

Defined in: core/types/schema.ts:30

---

ISchemaSortsMapValue

Ƭ ISchemaSortsMapValue: { schema_id: string ; sort: ViewSorts } & TSchemaUnit

Defined in: core/types/schema.ts:29

---

ISpaceUpdateInput

Ƭ ISpaceUpdateInput: Partial<Pick<ISpace, ElementType<typeof TSpaceUpdateKeys>>>

Defined in: core/types/block.ts:280

---

ISpaceViewUpdateInput

Ƭ ISpaceViewUpdateInput: Partial<Pick<ISpaceView, ElementType<typeof TSpaceViewUpdateKeys>>>

Defined in: core/types/block.ts:286

---

IUserSettingsUpdateInput

Ƭ IUserSettingsUpdateInput: Partial<Pick<IUserSettingsSettings, ElementType<typeof TUserSettingsUpdateKeys>>>

Defined in: core/types/block.ts:288

---

JoinFunctionCreateInput

Ƭ JoinFunctionCreateInput: IFunctionCreateInput<join, TTextResultType>

Defined in: core/types/formula.ts:76

---

LargerEqFunctionCreateInput

Ƭ LargerEqFunctionCreateInput: IFunctionCreateInput<largerEq, Tuple2<TCheckboxResultType>>

Defined in: core/types/formula.ts:85

---

LargerFunctionCreateInput

Ƭ LargerFunctionCreateInput: IFunctionCreateInput<larger, Tuple2<TCheckboxResultType>>

Defined in: core/types/formula.ts:84

---

LengthFunctionCreateInput

Ƭ LengthFunctionCreateInput: IFunctionCreateInput<length, TTextResultType>

Defined in: core/types/formula.ts:138

---

LnFunctionCreateInput

Ƭ LnFunctionCreateInput: IFunctionCreateInput<ln, TNumberResultType>

Defined in: core/types/formula.ts:107

---

Log10FunctionCreateInput

Ƭ Log10FunctionCreateInput: IFunctionCreateInput<log10, TNumberResultType>

Defined in: core/types/formula.ts:108

---

Log2FunctionCreateInput

Ƭ Log2FunctionCreateInput: IFunctionCreateInput<log2, TNumberResultType>

Defined in: core/types/formula.ts:109

---

Logger

Ƭ Logger: false | (method: TMethodType, subject: TDataType, id: string) => void

Defined in: core/types/nishan.ts:7

---

MaxFunctionCreateInput

Ƭ MaxFunctionCreateInput: IFunctionCreateInput<max, TNumberResultType>

Defined in: core/types/formula.ts:110

---

MinFunctionCreateInput

Ƭ MinFunctionCreateInput: IFunctionCreateInput<min, TNumberResultType>

Defined in: core/types/formula.ts:111

---

MinuteFunctionCreateInput

Ƭ MinuteFunctionCreateInput: IFunctionCreateInput<minute, TDateResultType>

Defined in: core/types/formula.ts:132

---

ModFunctionCreateInput

Ƭ ModFunctionCreateInput: IFunctionCreateInput<mod, Tuple2<TNumberResultType>>

Defined in: core/types/formula.ts:93

---

MonthFunctionCreateInput

Ƭ MonthFunctionCreateInput: IFunctionCreateInput<month, TDateResultType>

Defined in: core/types/formula.ts:136

---

MultiplyFunctionCreateInput

Ƭ MultiplyFunctionCreateInput: IFunctionCreateInput<multiply, Tuple2<TNumberResultType>>

Defined in: core/types/formula.ts:91

---

NotFunctionCreateInput

Ƭ NotFunctionCreateInput: IFunctionCreateInput<not, TCheckboxResultType>

Defined in: core/types/formula.ts:88

---

NowFunctionCreateInput

Ƭ NowFunctionCreateInput: { args?: [] ; function: now }

Type declaration:

Name	Type
args?	[]
function	now

Defined in: core/types/formula.ts:140

---

NumberAddFunctionCreateInput

Ƭ NumberAddFunctionCreateInput: { args: Tuple2<TNumberResultType> ; function: add ; result_type: number }

Type declaration:

Name	Type
args	Tuple2<TNumberResultType>
function	add
result_type	number

Defined in: core/types/formula.ts:57

---

NumberIfFunctionCreateInput

Ƭ NumberIfFunctionCreateInput: { args: Tuple12<TCheckboxResultType, TNumberResultType> ; function: if ; result_type: number }

Type declaration:

Name	Type
args	Tuple12<TCheckboxResultType, TNumberResultType>
function	if
result_type	number

Defined in: core/types/formula.ts:25

---

OrFunctionCreateInput

Ƭ OrFunctionCreateInput: IFunctionCreateInput<or, Tuple2<TCheckboxResultType>>

Defined in: core/types/formula.ts:83

---

PowFunctionCreateInput

Ƭ PowFunctionCreateInput: IFunctionCreateInput<pow, Tuple2<TNumberResultType>>

Defined in: core/types/formula.ts:92

---

Predicate

Ƭ Predicate<T>: (T: T, index: number) => Promise<boolean> | boolean | void | null | undefined

Type parameters:

Name
T

Defined in: core/types/utils.ts:2

---

ReplaceAllFunctionCreateInput

Ƭ ReplaceAllFunctionCreateInput: IFunctionCreateInput<replaceAll, Tuple12<TNumberResultType, TTextResultType> | Tuple12<TTextResultType, TTextResultType> | Tuple12<TCheckboxResultType, TTextResultType>>

Defined in: core/types/formula.ts:63

---

ReplaceFunctionCreateInput

Ƭ ReplaceFunctionCreateInput: IFunctionCreateInput<replace, Tuple12<TNumberResultType, TTextResultType> | Tuple12<TTextResultType, TTextResultType> | Tuple12<TCheckboxResultType, TTextResultType>>

Defined in: core/types/formula.ts:69

---

RepositionParams

Ƭ RepositionParams: { id: string ; position: before | after } | number | undefined

Defined in: core/types/block.ts:269

---

RoundFunctionCreateInput

Ƭ RoundFunctionCreateInput: IFunctionCreateInput<round, TNumberResultType>

Defined in: core/types/formula.ts:112

---

SchemaFormalPropertiesUpdateInput

Ƭ SchemaFormalPropertiesUpdateInput: Partial<{ position: number ; visible: boolean ; width: number }>

Defined in: core/types/schema.ts:38

---

SignFunctionCreateInput

Ƭ SignFunctionCreateInput: IFunctionCreateInput<sign, TNumberResultType>

Defined in: core/types/formula.ts:113

---

SliceFunctionCreateInput

Ƭ SliceFunctionCreateInput: IFunctionCreateInput<slice, [TTextResultType, TNumberResultType] | TNumberResultType>

Defined in: core/types/formula.ts:77

---

SmallerEqFunctionCreateInput

Ƭ SmallerEqFunctionCreateInput: IFunctionCreateInput<smallerEq, Tuple2<TCheckboxResultType>>

Defined in: core/types/formula.ts:87

---

SmallerFunctionCreateInput

Ƭ SmallerFunctionCreateInput: IFunctionCreateInput<smaller, Tuple2<TCheckboxResultType>>

Defined in: core/types/formula.ts:86

---

SqrtFunctionCreateInput

Ƭ SqrtFunctionCreateInput: IFunctionCreateInput<sqrt, TNumberResultType>

Defined in: core/types/formula.ts:114

---

StartFunctionCreateInput

Ƭ StartFunctionCreateInput: IFunctionCreateInput<start, TDateResultType>

Defined in: core/types/formula.ts:115

---

SubtractFunctionCreateInput

Ƭ SubtractFunctionCreateInput: IFunctionCreateInput<subtract, Tuple2<TNumberResultType>>

Defined in: core/types/formula.ts:89

---

TAdvancedBlockInput

Ƭ TAdvancedBlockInput: IBreadcrumbInput | IFactoryInput | IEquationInput | ITOCInput

Defined in: core/types/block.ts:219

---

TAggregationsCreateInput

Ƭ TAggregationsCreateInput: IAggregationsCreateInput<text> | IAggregationsCreateInput<title> | IAggregationsCreateInput<number> | IAggregationsCreateInput<select> | IAggregationsCreateInput<multi_select> | IAggregationsCreateInput<date> | IAggregationsCreateInput<person> | IAggregationsCreateInput<file> | IAggregationsCreateInput<checkbox> | IAggregationsCreateInput<url> | IAggregationsCreateInput<email> | IAggregationsCreateInput<phone_number> | IAggregationsCreateInput<formula> | IAggregationsCreateInput<relation> | IAggregationsCreateInput<rollup> | IAggregationsCreateInput<created_time> | IAggregationsCreateInput<created_by> | IAggregationsCreateInput<last_edited_time> | IAggregationsCreateInput<last_edited_by>

Defined in: core/types/aggregations.ts:14

---

TAggregationsUpdateInput

Ƭ TAggregationsUpdateInput: IAggregationsUpdateInput<text> | IAggregationsUpdateInput<title> | IAggregationsUpdateInput<number> | IAggregationsUpdateInput<select> | IAggregationsUpdateInput<multi_select> | IAggregationsUpdateInput<date> | IAggregationsUpdateInput<person> | IAggregationsUpdateInput<file> | IAggregationsUpdateInput<checkbox> | IAggregationsUpdateInput<url> | IAggregationsUpdateInput<email> | IAggregationsUpdateInput<phone_number> | IAggregationsUpdateInput<formula> | IAggregationsUpdateInput<relation> | IAggregationsUpdateInput<rollup> | IAggregationsUpdateInput<created_time> | IAggregationsUpdateInput<created_by> | IAggregationsUpdateInput<last_edited_time> | IAggregationsUpdateInput<last_edited_by>

Defined in: core/types/aggregations.ts:35

---

TBasicBlockInput

Ƭ TBasicBlockInput: ILinkToPageInput | IPageCreateInput | ITodoInput | ICalloutInput | IDividerInput | IQuoteInput | IToggleInput | IBulletedListInput | INumberedListInput | ISubSubHeaderInput | ISubHeaderInput | IHeaderInput | ITextInput

Defined in: core/types/block.ts:192

---

TBlockCreateInput

Ƭ TBlockCreateInput: TBlockInput & { position?: RepositionParams }

Defined in: core/types/block.ts:290

---

TBlockInput

Ƭ TBlockInput: TMediaBlockInput | TBasicBlockInput | TAdvancedBlockInput | TEmbedBlockInput | TCollectionBlockInput | IColumnListInput

Defined in: core/types/block.ts:267

---

TCheckboxFunctionCreateInput

Ƭ TCheckboxFunctionCreateInput: CheckboxIfFunctionCreateInput | EqualFunctionCreateInput | UnequalFunctionCreateInput | AndFunctionCreateInput | OrFunctionCreateInput | LargerFunctionCreateInput | LargerEqFunctionCreateInput | SmallerFunctionCreateInput | SmallerEqFunctionCreateInput | NotFunctionCreateInput | EmptyFunctionCreateInput | TestFunctionCreateInput | ContainsFunctionCreateInput

Defined in: core/types/formula.ts:155

---

TCheckboxResultType

Ƭ TCheckboxResultType: boolean | TCheckboxFunctionCreateInput | { property: string }

Defined in: core/types/formula.ts:15

---

TCollectionBlockInput

Ƭ TCollectionBlockInput: ICollectionViewInput | ICollectionViewPageInput | ILinkedDBInput

Defined in: core/types/block.ts:40

---

TDateFunctionCreateInput

Ƭ TDateFunctionCreateInput: DateIfFunctionCreateInput | FormatDateFunctionCreateInput | DateSubtractFunctionCreateInput | DateAddFunctionCreateInput | NowFunctionCreateInput | StartFunctionCreateInput | EndFunctionCreateInput | TimestampFunctionCreateInput | FromTimestampFunctionCreateInput | MinuteFunctionCreateInput | HourFunctionCreateInput | DayFunctionCreateInput | DateFunctionCreateInput | MonthFunctionCreateInput | YearFunctionCreateInput

Defined in: core/types/formula.ts:198

---

TDateResultType

Ƭ TDateResultType: Date | TDateFunctionCreateInput | { property: string }

Defined in: core/types/formula.ts:17

---

TEmbedBlockInput

Ƭ TEmbedBlockInput: IEmbedInput | IFigmaInput | IMapsInput | ICodepenInput | IDriveInput | IGistInput | ITweetInput

Defined in: core/types/block.ts:265

---

TFormulaCreateInput

Ƭ TFormulaCreateInput: TDateFunctionCreateInput | TTextFunctionCreateInput | TNumberFunctionCreateInput | TCheckboxFunctionCreateInput

Defined in: core/types/formula.ts:215

---

TMediaBlockInput

Ƭ TMediaBlockInput: IVideoInput | IImageInput | IAudioInput | IWebBookmarkInput | ICodeInput | IFileInput

Defined in: core/types/block.ts:83

---

TMethodType

Ƭ TMethodType: CREATE | READ | UPDATE | DELETE

Defined in: core/types/nishan.ts:5

---

TNumberFunctionCreateInput

Ƭ TNumberFunctionCreateInput: NumberAddFunctionCreateInput | SubtractFunctionCreateInput | DivideFunctionCreateInput | MultiplyFunctionCreateInput | PowFunctionCreateInput | ModFunctionCreateInput | UnaryMinusFunctionCreateInput | UnaryPlusFunctionCreateInput | NumberIfFunctionCreateInput | DateBetweenFunctionCreateInput | TimestampFunctionCreateInput | SqrtFunctionCreateInput | SignFunctionCreateInput | RoundFunctionCreateInput | MinFunctionCreateInput | MaxFunctionCreateInput | Log2FunctionCreateInput | Log10FunctionCreateInput | LnFunctionCreateInput | FloorFunctionCreateInput | ExpFunctionCreateInput | CeilFunctionCreateInput | CbrtFunctionCreateInput | AbsFunctionCreateInput | ToNumberFunctionCreateInput | LengthFunctionCreateInput

Defined in: core/types/formula.ts:170

---

TNumberResultType

Ƭ TNumberResultType: number | TNumberFunctionCreateInput | { property: string }

Defined in: core/types/formula.ts:16

---

TResultType

Ƭ TResultType: TCheckboxResultType | TTextResultType | TNumberResultType | TDateResultType

Defined in: core/types/formula.ts:4

---

TSchemaUnitInput

Ƭ TSchemaUnitInput: TBasicSchemaUnit | RelationSchemaUnit | RollupSchemaUnit | CreatedTimeSchemaUnit | CreatedBySchemaUnit | LastEditedTimeSchemaUnit | LastEditedBySchemaUnit | FormulaSchemaUnitInput

Defined in: core/types/schema.ts:40

---

TSortCreateInput

Ƭ TSortCreateInput: [string, TSortValue, number] | [string, TSortValue]

Defined in: core/types/sort.ts:3

---

TSortUpdateInput

Ƭ TSortUpdateInput: TSortValue | [TSortValue, number]

Defined in: core/types/sort.ts:4

---

TTextFunctionCreateInput

Ƭ TTextFunctionCreateInput: TextIfFunctionCreateInput | TextAddFunctionCreateInput | ReplaceAllFunctionCreateInput | ReplaceFunctionCreateInput | ConcatFunctionCreateInput | JoinFunctionCreateInput | SliceFunctionCreateInput | FormatFunctionCreateInput

Defined in: core/types/formula.ts:145

---

TTextResultType

Ƭ TTextResultType: string | TTextFunctionCreateInput | { property: string }

Defined in: core/types/formula.ts:18

---

TViewCreateInput

Ƭ TViewCreateInput: TableViewCreateInput | ListViewCreateInput | BoardViewCreateInput | GalleryViewCreateInput | CalendarViewCreateInput | TimelineViewCreateInput

Defined in: core/types/view.ts:57

---

TViewFilterCreateInput

Ƭ TViewFilterCreateInput: IViewFilterCreateInput<checkbox> | IViewFilterCreateInput<text> | IViewFilterCreateInput<number> | IViewFilterCreateInput<select> | IViewFilterCreateInput<multi_select> | IViewFilterCreateInput<title> | IViewFilterCreateInput<date> | IViewFilterCreateInput<person> | IViewFilterCreateInput<file> | IViewFilterCreateInput<url> | IViewFilterCreateInput<email> | IViewFilterCreateInput<phone_number> | IViewFilterCreateInput<formula> | IViewFilterCreateInput<relation> | IViewFilterCreateInput<rollup> | IViewFilterCreateInput<created_time> | IViewFilterCreateInput<created_by> | IViewFilterCreateInput<last_edited_time> | IViewFilterCreateInput<last_edited_by>

Defined in: core/types/filter.ts:20

---

TViewFilterUpdateInput

Ƭ TViewFilterUpdateInput: IViewFilterUpdateInput<checkbox> | IViewFilterUpdateInput<text> | IViewFilterUpdateInput<number> | IViewFilterUpdateInput<select> | IViewFilterUpdateInput<multi_select> | IViewFilterUpdateInput<title> | IViewFilterUpdateInput<date> | IViewFilterUpdateInput<person> | IViewFilterUpdateInput<file> | IViewFilterUpdateInput<url> | IViewFilterUpdateInput<email> | IViewFilterUpdateInput<phone_number> | IViewFilterUpdateInput<formula> | IViewFilterUpdateInput<relation> | IViewFilterUpdateInput<rollup> | IViewFilterUpdateInput<created_time> | IViewFilterUpdateInput<created_by> | IViewFilterUpdateInput<last_edited_time> | IViewFilterUpdateInput<last_edited_by>

Defined in: core/types/filter.ts:41

---

TViewSchemaUnitsCreateInput

Ƭ TViewSchemaUnitsCreateInput: IViewSchemaUnitsCreateInput<text> | IViewSchemaUnitsCreateInput<title> | IViewSchemaUnitsCreateInput<number> | IViewSchemaUnitsCreateInput<select> | IViewSchemaUnitsCreateInput<multi_select> | IViewSchemaUnitsCreateInput<date> | IViewSchemaUnitsCreateInput<person> | IViewSchemaUnitsCreateInput<file> | IViewSchemaUnitsCreateInput<checkbox> | IViewSchemaUnitsCreateInput<url> | IViewSchemaUnitsCreateInput<email> | IViewSchemaUnitsCreateInput<phone_number> | IViewSchemaUnitsCreateInput<formula> | IViewSchemaUnitsCreateInput<relation> | IViewSchemaUnitsCreateInput<rollup> | IViewSchemaUnitsCreateInput<created_time> | IViewSchemaUnitsCreateInput<created_by> | IViewSchemaUnitsCreateInput<last_edited_time> | IViewSchemaUnitsCreateInput<last_edited_by>

Defined in: core/types/view.ts:78

---

TestFunctionCreateInput

Ƭ TestFunctionCreateInput: IFunctionCreateInput<test, [TNumberResultType, TTextResultType] | [TTextResultType, TTextResultType] | [TCheckboxResultType, TTextResultType]>

Defined in: core/types/formula.ts:97

---

TextAddFunctionCreateInput

Ƭ TextAddFunctionCreateInput: { args: Tuple2<TTextResultType> ; function: add ; result_type: text }

Type declaration:

Name	Type
args	Tuple2<TTextResultType>
function	add
result_type	text

Defined in: core/types/formula.ts:51

---

TextIfFunctionCreateInput

Ƭ TextIfFunctionCreateInput: { args: Tuple12<TCheckboxResultType, TTextResultType> ; function: if ; result_type: text }

Type declaration:

Name	Type
args	Tuple12<TCheckboxResultType, TTextResultType>
function	if
result_type	text

Defined in: core/types/formula.ts:31

---

TimestampFunctionCreateInput

Ƭ TimestampFunctionCreateInput: IFunctionCreateInput<timestamp, TDateResultType>

Defined in: core/types/formula.ts:130

---

ToNumberFunctionCreateInput

Ƭ ToNumberFunctionCreateInput: IFunctionCreateInput<toNumber, TResultType>

Defined in: core/types/formula.ts:139

---

UnaryMinusFunctionCreateInput

Ƭ UnaryMinusFunctionCreateInput: IFunctionCreateInput<unaryMinus, TNumberResultType>

Defined in: core/types/formula.ts:94

---

UnaryPlusFunctionCreateInput

Ƭ UnaryPlusFunctionCreateInput: IFunctionCreateInput<unaryPlus, TNumberResultType>

Defined in: core/types/formula.ts:95

---

UnequalFunctionCreateInput

Ƭ UnequalFunctionCreateInput: IFunctionCreateInput<unequal, Tuple2AnyResultType>

Defined in: core/types/formula.ts:50

---

UpdateType

Ƭ UpdateType<T1, T2>: [string, T2] | (T: T1, index: number) => Promise<T2> | T2 | void | null | undefined

Type parameters:

Name
T1
T2

Defined in: core/types/nishan.ts:25

---

UpdateTypes

Ƭ UpdateTypes<T1, T2>: [string, T2][] | (T: T1, index: number) => Promise<T2> | T2 | void | null | undefined

Type parameters:

Name
T1
T2

Defined in: core/types/nishan.ts:22

---

YearFunctionCreateInput

Ƭ YearFunctionCreateInput: IFunctionCreateInput<year, TDateResultType>

Defined in: core/types/formula.ts:137

Variables

Operation

• Const Operation: Record<TDataType, Record<TOperationCommand, (id: string, path: string[], args: Args) => IOperation>>

Defined in: core/utils/chunk.ts:23

---

TCollectionUpdateKeys

• Const TCollectionUpdateKeys: readonly name[]

Defined in: core/types/block.ts:275

---

TNotionUserUpdateKeys

• Const TNotionUserUpdateKeys: readonly family_name[]

Defined in: core/types/block.ts:276

---

TSpaceUpdateKeys

• Const TSpaceUpdateKeys: readonly name[]

Defined in: core/types/block.ts:274

---

TSpaceViewUpdateKeys

• Const TSpaceViewUpdateKeys: readonly notify_desktop[]

Defined in: core/types/block.ts:277

---

TUserSettingsUpdateKeys

• Const TUserSettingsUpdateKeys: readonly start_day_of_week[]

Defined in: core/types/block.ts:278

Functions

createBlockClass

▸ createBlockClass(type: TBlockType, id: string, props: Pick<NishanArg, token | space_id | shard_id | interval | logger | stack | user_id | cache>): any

Parameters:

Name	Type
type	TBlockType
id	string
props	Pick<NishanArg, token | space_id | shard_id | interval | logger | stack | user_id | cache>

Returns: any

Defined in: core/utils/createBlockClass.ts:4

---

createBlockMap

▸ createBlockMap(): ITBlock

Returns: ITBlock

Defined in: core/utils/createMaps.ts:3

---

createCollection

▸ createCollection(param: ICollectionBlockInput, parent_id: string, props: Pick<NishanArg, token | space_id | shard_id | interval | logger | stack | user_id | cache>): [string, string[], ITView]

Parameters:

Name	Type
param	ICollectionBlockInput
parent_id	string
props	Pick<NishanArg, token | space_id | shard_id | interval | logger | stack | user_id | cache>

Returns: [string, string[], ITView]

Defined in: core/utils/createCollection.ts:6

---

createPageMap

▸ createPageMap(): ITPage

Returns: ITPage

Defined in: core/utils/createMaps.ts:78

---

createSchemaUnitMap

▸ createSchemaUnitMap(): ITSchemaUnit

Returns: ITSchemaUnit

Defined in: core/utils/createMaps.ts:54

---

createShortId

▸ createShortId(length?: number): string

Parameters:

Name	Type	Default value
length	number	5

Returns: string

Defined in: core/utils/ids.ts:1

---

createViewMap

▸ createViewMap(): ITView

Returns: ITView

Defined in: core/utils/createMaps.ts:43

---

createViews

▸ createViews(schema: Schema, views: TViewCreateInput[], collection_id: string, parent_id: string, props: Pick<NishanArg, token | space_id | shard_id | interval | logger | stack | user_id | cache>, current_id?: string): [string[], ITView]

Parameters:

Name	Type
schema	Schema
views	TViewCreateInput[]
collection_id	string
parent_id	string
props	Pick<NishanArg, token | space_id | shard_id | interval | logger | stack | user_id | cache>
current_id?	string

Returns: [string[], ITView]

Defined in: core/utils/createViews.ts:6

---

detectChildData

▸ ConstdetectChildData(type: block | collection | collection_view | space | notion_user | space_view | user_root | user_settings, data: TBlock): [string, block | collection | collection_view | space | notion_user | space_view | user_root | user_settings]

Parameters:

Name	Type
type	block | collection | collection_view | space | notion_user | space_view | user_root | user_settings
data	TBlock

Returns: [string, block | collection | collection_view | space | notion_user | space_view | user_root | user_settings]

Defined in: core/utils/detectChildData.ts:3

---

error

▸ Consterror(msg: string): string

Parameters:

Name	Type
msg	string

Returns: string

Defined in: core/utils/logs.ts:3

---

formulateResultTypeFromSchemaType

▸ formulateResultTypeFromSchemaType(type: number | text | file | select | multi_select | title | date | person | checkbox | url | email | phone_number | relation | rollup | created_time | created_by | last_edited_time | last_edited_by | formula): TFormulaResultType

Parameters:

Name	Type
type	number | text | file | select | multi_select | title | date | person | checkbox | url | email | phone_number | relation | rollup | created_time | created_by | last_edited_time | last_edited_by | formula

Returns: TFormulaResultType

Defined in: core/utils/parseFormula.ts:66

---

generateId

▸ generateId(id: undefined | string): string

Parameters:

Name	Type
id	undefined | string

Returns: string

Defined in: core/utils/generateId.ts:4

---

getAggregationsMap

▸ getAggregationsMap(data: ITableView | IBoardView | ITimelineView, collection: ICollection): readonly ISchemaAggregationMap[]

Parameters:

Name	Type
data	ITableView | IBoardView | ITimelineView
collection	ICollection

Returns: readonly ISchemaAggregationMap[]

Defined in: core/utils/createViewMaps.ts:16

---

getFiltersMap

▸ getFiltersMap(data: TView, collection: ICollection): readonly ISchemaFiltersMap[]

Parameters:

Name	Type
data	TView
collection	ICollection

Returns: readonly ISchemaFiltersMap[]

Defined in: core/utils/createViewMaps.ts:46

---

getFormatPropertiesMap

▸ getFormatPropertiesMap(data: TView, collection: ICollection): readonly ISchemaFormatMap[]

Parameters:

Name	Type
data	TView
collection	ICollection

Returns: readonly ISchemaFormatMap[]

Defined in: core/utils/createViewMaps.ts:64

---

getSchemaMap

▸ getSchemaMap(collection: ICollection): ISchemaMap

Parameters:

Name	Type
collection	ICollection

Returns: ISchemaMap

Defined in: core/utils/createViewMaps.ts:5

---

getSortsMap

▸ getSortsMap(data: TView, collection: ICollection): readonly ISchemaSortsMap[]

Parameters:

Name	Type
data	TView
collection	ICollection

Returns: readonly ISchemaSortsMap[]

Defined in: core/utils/createViewMaps.ts:30

---

initializeViewAggregations

▸ initializeViewAggregations(data: ITableView | IBoardView | ITimelineView): ViewAggregations[]

Parameters:

Name	Type
data	ITableView | IBoardView | ITimelineView

Returns: ViewAggregations[]

Defined in: core/utils/initializeView.ts:16

---

initializeViewFilters

▸ initializeViewFilters(data: TView): IViewFilter

Parameters:

Name	Type
data	TView

Returns: IViewFilter

Defined in: core/utils/initializeView.ts:3

---

initializeViewSorts

▸ initializeViewSorts(data: TView): ViewSorts[]

Parameters:

Name	Type
data	TView

Returns: ViewSorts[]

Defined in: core/utils/initializeView.ts:10

---

iterateAndDeleteChildren

▸ ConstiterateAndDeleteChildren<T, TD>(args: FilterTypes<TD>, transform: (id: string) => undefined | TD, options: IterateAndDeleteOptions<T>, cb?: (id: string, data: TD) => any): Promise<TD[]>

Type parameters:

Name	Type
T	TData
TD	-

Parameters:

Name	Type
args	FilterTypes<TD>
transform	(id: string) => undefined | TD
options	IterateAndDeleteOptions<T>
cb?	(id: string, data: TD) => any

Returns: Promise<TD[]>

Defined in: core/utils/iterateChildren.ts:74

---

iterateAndGetChildren

▸ ConstiterateAndGetChildren<T, TD, C>(args: FilterTypes<TD>, transform: (id: string) => undefined | TD, options: IterateAndGetOptions<T, C>, cb?: (id: string, data: TD, container: C) => any): Promise<C>

Type parameters:

Name	Type
T	TData
TD	-
C	-

Parameters:

Name	Type
args	FilterTypes<TD>
transform	(id: string) => undefined | TD
options	IterateAndGetOptions<T, C>
cb?	(id: string, data: TD, container: C) => any

Returns: Promise<C>

Defined in: core/utils/iterateChildren.ts:38

---

iterateAndUpdateChildren

▸ ConstiterateAndUpdateChildren<T, CD, RD, C>(args: UpdateTypes<CD, RD>, transform: (id: string) => undefined | CD, options: IterateAndUpdateOptions<T, C>, cb?: (id: string, current\_data: CD, updated\_data: RD, container: C) => any): Promise<C>

Type parameters:

Name	Type	Default
T	TData	-
CD	-	-
RD	-	-
C	-	any[]

Parameters:

Name	Type
args	UpdateTypes<CD, RD>
transform	(id: string) => undefined | CD
options	IterateAndUpdateOptions<T, C>
cb?	(id: string, current\_data: CD, updated\_data: RD, container: C) => any

Returns: Promise<C>

Defined in: core/utils/iterateChildren.ts:128

---

nestedContentPopulate

▸ nestedContentPopulate(contents: TBlockCreateInput[], parent_id: string, parent_table: block | collection | space, props: Pick<NishanArg, token | space_id | shard_id | interval | logger | stack | user_id | cache>, this_id: string): Promise<ITBlock>

Parameters:

Name	Type
contents	TBlockCreateInput[]
parent_id	string
parent_table	block | collection | space
props	Pick<NishanArg, token | space_id | shard_id | interval | logger | stack | user_id | cache>
this_id	string

Returns: Promise<ITBlock>

Defined in: core/utils/nestedContentPopulate.ts:6

---

parseFormula

▸ parseFormula(formula: TFormulaCreateInput, schema_map: ISchemaMap): TFormula

Parameters:

Name	Type
formula	TFormulaCreateInput
schema_map	ISchemaMap

Returns: TFormula

Defined in: core/utils/parseFormula.ts:93

---

populateFilters

▸ populateFilters(filters: undefined | TViewFilterCreateInput[], parent_filter: (IViewFilter | TextViewFilters | TitleViewFilters | NumberViewFilters | SelectViewFilters | MultiSelectViewFilters | DateViewFilters | PersonViewFilters | FileViewFilters | CheckboxViewFilters | UrlViewFilters | EmailViewFilters | PhoneNumberViewFilters | RelationViewFilters | CreatedTimeViewFilters | CreatedByViewFilters | LastEditedTimeViewFilters | LastEditedByViewFilters)[], name_map: Map<string, { schema_id: string } & TextSchemaUnit | { schema_id: string } & NumberSchemaUnit | { schema_id: string } & SelectSchemaUnit | { schema_id: string } & MultiSelectSchemaUnit | { schema_id: string } & TitleSchemaUnit | { schema_id: string } & DateSchemaUnit | { schema_id: string } & PersonSchemaUnit | { schema_id: string } & FileSchemaUnit | { schema_id: string } & CheckboxSchemaUnit | { schema_id: string } & UrlSchemaUnit | { schema_id: string } & EmailSchemaUnit | { schema_id: string } & PhoneNumberSchemaUnit | { schema_id: string } & RelationSchemaUnit | { schema_id: string } & RollupSchemaUnit | { schema_id: string } & CreatedTimeSchemaUnit | { schema_id: string } & CreatedBySchemaUnit | { schema_id: string } & LastEditedTimeSchemaUnit | { schema_id: string } & LastEditedBySchemaUnit | { schema_id: string } & FormulaSchemaUnit>): void

Parameters:

Name	Type
filters	undefined | TViewFilterCreateInput[]
parent_filter	(IViewFilter | TextViewFilters | TitleViewFilters | NumberViewFilters | SelectViewFilters | MultiSelectViewFilters | DateViewFilters | PersonViewFilters | FileViewFilters | CheckboxViewFilters | UrlViewFilters | EmailViewFilters | PhoneNumberViewFilters | RelationViewFilters | CreatedTimeViewFilters | CreatedByViewFilters | LastEditedTimeViewFilters | LastEditedByViewFilters)[]
name_map	Map<string, { schema_id: string } & TextSchemaUnit | { schema_id: string } & NumberSchemaUnit | { schema_id: string } & SelectSchemaUnit | { schema_id: string } & MultiSelectSchemaUnit | { schema_id: string } & TitleSchemaUnit | { schema_id: string } & DateSchemaUnit | { schema_id: string } & PersonSchemaUnit | { schema_id: string } & FileSchemaUnit | { schema_id: string } & CheckboxSchemaUnit | { schema_id: string } & UrlSchemaUnit | { schema_id: string } & EmailSchemaUnit | { schema_id: string } & PhoneNumberSchemaUnit | { schema_id: string } & RelationSchemaUnit | { schema_id: string } & RollupSchemaUnit | { schema_id: string } & CreatedTimeSchemaUnit | { schema_id: string } & CreatedBySchemaUnit | { schema_id: string } & LastEditedTimeSchemaUnit | { schema_id: string } & LastEditedBySchemaUnit | { schema_id: string } & FormulaSchemaUnit>

Returns: void

Defined in: core/utils/populateFilters.ts:4

---

positionChildren

▸ positionChildren(arg: PositionChildrenParam): IOperation

Parameters:

Name	Type
arg	PositionChildrenParam

Returns: IOperation

Defined in: core/utils/positionChildren.ts:8

---

slugify

▸ slugify(word: string): string

Parameters:

Name	Type
word	string

Returns: string

Defined in: core/utils/slugify.ts:1

---

validateUUID

▸ validateUUID(uuid: string): boolean

Parameters:

Name	Type
uuid	string

Returns: boolean

Defined in: core/utils/uuid.ts:2

---

warn

▸ Constwarn(msg: string): string

Parameters:

Name	Type
msg	string

Returns: string

Defined in: core/utils/logs.ts:7