cover

const cover: object

Defined in: src/helpers/file.helpers.ts:165

Helpers that create cover image objects.

Type Declaration

external

external: (url) => ExternalRef = externalCover

Create an external cover image object.

Parameters

url

string

Returns

ExternalRef

Example

cover.external('https://example.com/banner.jpg')

fileUpload

fileUpload: (id) => FileUploadRef = fileUploadCover

Create a file-upload cover image object.

Parameters

id

string

Returns

FileUploadRef

Example

cover.fileUpload('upload-id')

Example

import { cover } from '@visus-io/notion-sdk-ts';

notion.pages.create({
  parent: { page_id: 'page-id' },
  cover: cover.external('https://example.com/banner.jpg'),
  // ...
});