@nishans/core / Exports / UserSettings

Class: UserSettings

A class to represent user settings of Notion

noinheritdoc

Hierarchy

• Data<IUserSettings>

  ↳ UserSettings

Index

Constructors

• constructor

Properties

• cache
• getConfigs
• headers
• id
• init_cache
• interval
• logger
• shard_id
• space_id
• stack
• token
• type
• user_id

Methods

• addToChildArray
• deleteCachedData
• deleteIterate
• emptyStack
• executeOperation
• getCachedData
• getIterate
• getLastEditedProps
• getProps
• initializeCache
• initializeCacheForSpecificData
• initializeCacheForThisData
• printStack
• returnNonCachedData
• saveToCache
• update
• updateCacheIfNotPresent
• updateCacheLocally
• updateCacheManually
• updateCachedData
• updateIterate
• updateLastEditedProps

Constructors

constructor

+ new UserSettings(arg: NishanArg): UserSettings

Parameters:

Name	Type
arg	NishanArg

Returns: UserSettings

Defined in: core/src/UserSettings.ts:9

Properties

cache

• cache: ICache

Defined in: endpoints/dist/src/Cache.d.ts:4

---

getConfigs

• Protected getConfigs: () => Configs

Defined in: endpoints/dist/src/Cache.d.ts:15

---

headers

• headers: { headers: { cookie: string ; x-notion-active-user-header: string } }

Type declaration:

Name	Type
headers	{ cookie: string ; x-notion-active-user-header: string }

Defined in: endpoints/dist/src/Cache.d.ts:7

---

id

• id: string

Defined in: core/src/Data.ts:33

---

init_cache

• init_cache: boolean= false

Defined in: core/src/Data.ts:35

---

interval

• interval: number

Defined in: endpoints/dist/src/Cache.d.ts:6

---

logger

• Protected logger: Logger

Defined in: core/src/Data.ts:36

---

shard_id

• shard_id: number

Defined in: core/src/Operations.ts:9

---

space_id

• space_id: string

Defined in: core/src/Operations.ts:8

---

stack

• stack: IOperation[]

Defined in: core/src/Operations.ts:7

---

token

• token: string

Defined in: endpoints/dist/src/Cache.d.ts:5

---

type

• type: block | collection | collection_view | space | notion_user | space_view | user_root | user_settings

Defined in: core/src/Data.ts:34

---

user_id

• user_id: string

Defined in: endpoints/dist/src/Cache.d.ts:13

Methods

addToChildArray

▸ ProtectedaddToChildArray(parent: TData, position: RepositionParams): void

Adds the passed block id in the child container array of parent

Parameters:

Name	Type
parent	TData
position	RepositionParams

Returns: void

created Operation and a function to update the cache and the class data

Defined in: core/src/Data.ts:86

---

deleteCachedData

▸ ProtecteddeleteCachedData(): void

Delete the cached data using the id

Returns: void

Defined in: core/src/Data.ts:76

---

deleteIterate

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

Type parameters:

Name
TD

Parameters:

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

Returns: Promise<TD[]>

Defined in: core/src/Data.ts:118

---

emptyStack

▸ emptyStack(): void

Returns: void

Defined in: core/src/Operations.ts:18

---

executeOperation

▸ executeOperation(): Promise<void>

Returns: Promise<void>

Defined in: core/src/Operations.ts:26

---

getCachedData

▸ getCachedData(): IUserSettings

Get the cached data using the current data id

Returns: IUserSettings

Defined in: core/src/Data.ts:62

---

getIterate

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

Type parameters:

Name
RD
C

Parameters:

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

Returns: Promise<C>

Defined in: core/src/Data.ts:138

---

getLastEditedProps

▸ ProtectedgetLastEditedProps(): object

Returns: object

Name	Type
last_edited_by_id	string
last_edited_by_table	string
last_edited_time	number

Defined in: core/src/Data.ts:48

---

getProps

▸ getProps(): object

Returns: object

Name	Type
cache	ICache
interval	number
logger	Logger
shard_id	number
space_id	string
stack	IOperation[]
token	string
user_id	string

Defined in: core/src/Data.ts:148

---

initializeCache

▸ initializeCache(): Promise<void>

Returns: Promise<void>

Defined in: endpoints/dist/src/Cache.d.ts:22

---

initializeCacheForSpecificData

▸ initializeCacheForSpecificData(id: string, type: block | collection | collection_view | space | notion_user | space_view | user_root | user_settings): Promise<void>

Parameters:

Name	Type
id	string
type	block | collection | collection_view | space | notion_user | space_view | user_root | user_settings

Returns: Promise<void>

Defined in: endpoints/dist/src/Cache.d.ts:25

---

initializeCacheForThisData

▸ ProtectedinitializeCacheForThisData(): Promise<void>

Returns: Promise<void>

Defined in: core/src/Data.ts:111

---

printStack

▸ printStack(): void

Returns: void

Defined in: core/src/Operations.ts:22

---

returnNonCachedData

▸ returnNonCachedData(ids: UpdateCacheManuallyParam): UpdateCacheManuallyParam

Parameters:

Name	Type
ids	UpdateCacheManuallyParam

Returns: UpdateCacheManuallyParam

Defined in: endpoints/dist/src/Cache.d.ts:21

---

saveToCache

▸ saveToCache(recordMap: Partial<RecordMap>): void

Save the passed recordMap to cache

Parameters:

Name	Type	Description
recordMap	Partial<RecordMap>	RecordMap map to save to cache

Returns: void

Defined in: endpoints/dist/src/Cache.d.ts:20

---

update

▸ update(opt: Partial<Pick<IUserSettingsSettings, start_day_of_week | time_zone | locale | preferred_locale | preferred_locale_origin>>): void

Update the current user settings

Parameters:

Name	Type	Description
opt	Partial<Pick<IUserSettingsSettings, start_day_of_week | time_zone | locale | preferred_locale | preferred_locale_origin>>	Options to update the User settings

Returns: void

Defined in: core/src/UserSettings.ts:18

---

updateCacheIfNotPresent

▸ updateCacheIfNotPresent(arg: UpdateCacheManuallyParam): Promise<void>

Parameters:

Name	Type
arg	UpdateCacheManuallyParam

Returns: Promise<void>

Defined in: endpoints/dist/src/Cache.d.ts:24

---

updateCacheLocally

▸ updateCacheLocally(arg: Partial<IUserSettings>, keys: readonly (id | version | start_day_of_week | time_zone | locale | preferred_locale | preferred_locale_origin | settings)[], appendToStack?: boolean): void

Update the cache of the data using only the passed keys

Parameters:

Name	Type	Description
arg	Partial<IUserSettings>
keys	readonly (id | version | start_day_of_week | time_zone | locale | preferred_locale | preferred_locale_origin | settings)[]
appendToStack?	boolean	-

Returns: void

Defined in: core/src/Data.ts:95

---

updateCacheManually

▸ updateCacheManually(arg: string | UpdateCacheManuallyParam): Promise<void>

Parameters:

Name	Type
arg	string | UpdateCacheManuallyParam

Returns: Promise<void>

Defined in: endpoints/dist/src/Cache.d.ts:23

---

updateCachedData

▸ updateCachedData(): Promise<void>

Returns: Promise<void>

Defined in: core/src/Data.ts:69

---

updateIterate

▸ ProtectedupdateIterate<TD, RD, C>(args: UpdateTypes<TD, RD>, options: IterateAndUpdateOptions<IUserSettings, C>, transform: (id: string) => undefined | TD, cb?: (id: string, data: TD, updated\_data: RD, container: C) => any): Promise<C>

Type parameters:

Name	Default
TD	-
RD	-
C	any

Parameters:

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

Returns: Promise<C>

Defined in: core/src/Data.ts:128

---

updateLastEditedProps

▸ ProtectedupdateLastEditedProps(data?: INotionUser | IText | ITodo | IHeader | ISubHeader | ISubSubHeader | IBulletedList | INumberedList | IToggle | IQuote | IDivider | ICallout | IPage | ICollectionView | ICollectionViewPage | ILinkToPage | IVideo | IAudio | IImage | IWebBookmark | ICode | IFile | ITOC | IEquation | IBreadcrumb | IFactory | IEmbed | ITweet | ICodepen | IMaps | IFigma | IDrive | IGist | IColumnList | IColumn | ICollection | ITableView | IListView | IBoardView | IGalleryView | ICalendarView | ITimelineView | ISpace | ISpaceView | IUserRoot | IUserSettings): void

Parameters:

Name

Type

data?

INotionUser | IText | ITodo | IHeader | ISubHeader | ISubSubHeader | IBulletedList | INumberedList | IToggle | IQuote | IDivider | ICallout | IPage | ICollectionView | ICollectionViewPage | ILinkToPage | IVideo | IAudio | IImage | IWebBookmark | ICode | IFile | ITOC | IEquation | IBreadcrumb | IFactory | IEmbed | ITweet | ICodepen | IMaps | IFigma | IDrive | IGist | IColumnList | IColumn | ICollection | ITableView | IListView | IBoardView | IGalleryView | ICalendarView | ITimelineView | ISpace | ISpaceView | IUserRoot | IUserSettings

Returns: void

Defined in: core/src/Data.ts:52