Options
All
  • Public
  • Public/Protected
  • All
Menu

contentful.js - v10.0.0-beta-v10.7

Index

Entities

Other

Other

AssetCollection

AssetCollection: ContentfulCollection<Asset>

AssetKey

AssetKey: { policy: string; secret: string }

Type declaration

  • policy: string
  • secret: string

AssetMimeType

AssetMimeType: "attachment" | "plaintext" | "image" | "audio" | "video" | "richtext" | "presentation" | "spreadsheet" | "pdfdocument" | "archive" | "code" | "markup"

AssetQueries

AssetQueries<Fields>: Partial<AssetFieldsQueries<Fields> & SysQueries<Pick<AssetSys, "createdAt" | "updatedAt" | "revision" | "id" | "type">> & FixedQueryOptions & FixedPagedOptions & { mimetype_group?: AssetMimeType } & Record<string, any>>

Type parameters

  • Fields: FieldsType = FieldsType

AssetSys

AssetSys: EntitySys

BasicEntryField

BasicEntryField: Symbol | Text | Integer | Number | Date | Boolean | Location | RichText | Object

ClientLogLevel

ClientLogLevel: "error" | "warning" | "info" | string

ContentTypeCollection

ContentTypeCollection: ContentfulCollection<ContentType>

ContentTypeFieldType

ContentTypeFieldType: "Symbol" | "Text" | "Integer" | "Number" | "Date" | "Boolean" | "Location" | "Link" | "Array" | "Object" | "RichText"

ContentTypeLink

ContentTypeLink: Link<"ContentType">

ContentfulClientApi

ContentfulClientApi: { withAllLocales: { withoutLinkResolution: ClientWithAllLocalesAndWithoutLinkResolution; withoutUnresolvableLinks: ClientWithAllLocalesAndWithLinkResolutionAndWithoutUnresolvableLinks } & ClientWithAllLocalesAndWithLinkResolutionAndWithUnresolvableLinks; withoutLinkResolution: { withAllLocales: ClientWithAllLocalesAndWithoutLinkResolution } & ClientWithoutLinkResolution; withoutUnresolvableLinks: { withAllLocales: ClientWithAllLocalesAndWithLinkResolutionAndWithoutUnresolvableLinks } & ClientWithLinkResolutionAndWithoutUnresolvableLinks } & DefaultClient

EntriesQueries

EntriesQueries<Fields>: Partial<EntryFieldsQueries<Fields> & SysQueries<Pick<EntrySys, "createdAt" | "updatedAt" | "revision" | "id" | "type">> & FixedQueryOptions & FixedPagedOptions & { content_type?: string } & Record<string, any> & { resolveLinks?: never }>

Type parameters

  • Fields: FieldsType = FieldsType

EntryCollection

EntryCollection<T>: AbstractEntryCollection<Entry<T>>

Type parameters

  • T

EntryCollectionWithAllLocalesAndWithLinkResolutionAndWithUnresolvableLinks

EntryCollectionWithAllLocalesAndWithLinkResolutionAndWithUnresolvableLinks<Fields, Locales>: AbstractEntryCollection<EntryWithAllLocalesAndWithLinkResolutionAndWithUnresolvableLinks<Fields, Locales>>

Type parameters

EntryCollectionWithAllLocalesAndWithLinkResolutionAndWithoutUnresolvableLinks

EntryCollectionWithAllLocalesAndWithLinkResolutionAndWithoutUnresolvableLinks<Fields, Locales>: AbstractEntryCollection<EntryWithAllLocalesAndWithLinkResolutionAndWithoutUnresolvableLinks<Fields, Locales>>

Type parameters

EntryCollectionWithAllLocalesAndWithoutLinkResolution

EntryCollectionWithAllLocalesAndWithoutLinkResolution<Fields, Locales>: AbstractEntryCollection<EntryWithAllLocalesAndWithoutLinkResolution<Fields, Locales>>

Type parameters

EntryCollectionWithLinkResolutionAndWithUnresolvableLinks

EntryCollectionWithLinkResolutionAndWithUnresolvableLinks<T>: AbstractEntryCollection<EntryWithLinkResolutionAndWithUnresolvableLinks<T>>

Type parameters

  • T

EntryCollectionWithLinkResolutionAndWithoutUnresolvableLinks

EntryCollectionWithLinkResolutionAndWithoutUnresolvableLinks<Fields>: AbstractEntryCollection<EntryWithLinkResolutionAndWithoutUnresolvableLinks<Fields>>

Type parameters

  • Fields

EntryCollectionWithoutLinkResolution

EntryCollectionWithoutLinkResolution<T>: EntryCollection<T>

Type parameters

  • T

EntryLink

EntryLink: Link<"Entry">

EntryWithAllLocalesAndWithLinkResolutionAndWithUnresolvableLinks

EntryWithAllLocalesAndWithLinkResolutionAndWithUnresolvableLinks<Fields, Locales>: { fields: { [ FieldName in keyof Fields]: { [ LocaleName in Locales]?: Fields[FieldName] extends EntryFields.Link<infer LinkedEntryFields> ? EntryWithAllLocalesAndWithLinkResolutionAndWithUnresolvableLinks<LinkedEntryFields, Locales> | undefined : Fields[FieldName] extends EntryFields.Link<infer LinkedEntryFields>[] ? EntryWithAllLocalesAndWithLinkResolutionAndWithUnresolvableLinks<LinkedEntryFields, Locales>[] | undefined : Fields[FieldName] } }; metadata: Metadata; sys: EntrySys }

Type parameters

Type declaration

EntryWithAllLocalesAndWithLinkResolutionAndWithoutUnresolvableLinks

EntryWithAllLocalesAndWithLinkResolutionAndWithoutUnresolvableLinks<Fields, Locales>: { fields: { [ FieldName in keyof Fields]: { [ LocaleName in Locales]?: Fields[FieldName] extends EntryFields.Link<infer LinkedEntryFields> ? EntryWithAllLocalesAndWithLinkResolutionAndWithoutUnresolvableLinks<LinkedEntryFields, Locales> | undefined : Fields[FieldName] extends EntryFields.Link<infer LinkedEntryFields>[] ? EntryWithAllLocalesAndWithLinkResolutionAndWithoutUnresolvableLinks<LinkedEntryFields, Locales>[] | undefined : Fields[FieldName] } }; metadata: Metadata; sys: EntrySys }

Type parameters

Type declaration

EntryWithLinkResolutionAndWithUnresolvableLinks

EntryWithLinkResolutionAndWithUnresolvableLinks<Fields>: { fields: { [ FieldName in keyof Fields]: Fields[FieldName] extends EntryFields.Link<infer LinkedEntryFields> ? EntryWithLinkResolutionAndWithUnresolvableLinks<LinkedEntryFields> | EntryLink : Fields[FieldName] extends EntryFields.Link<infer LinkedEntryFields>[] ? (EntryWithLinkResolutionAndWithUnresolvableLinks<LinkedEntryFields> | EntryLink)[] : Fields[FieldName] }; metadata: Metadata; sys: EntrySys }

Type parameters

  • Fields: FieldsType

Type declaration

EntryWithLinkResolutionAndWithoutUnresolvableLinks

EntryWithLinkResolutionAndWithoutUnresolvableLinks<Fields>: { fields: { [ FieldName in keyof Fields]: Fields[FieldName] extends EntryFields.Link<infer LinkedEntryFields> ? EntryWithLinkResolutionAndWithoutUnresolvableLinks<LinkedEntryFields> | undefined : Fields[FieldName] extends EntryFields.Link<infer LinkedEntryFields>[] ? EntryWithLinkResolutionAndWithoutUnresolvableLinks<LinkedEntryFields>[] | undefined : Fields[FieldName] }; metadata: Metadata; sys: EntrySys }

Type parameters

  • Fields: FieldsType

Type declaration

EntryWithoutLinkResolution

EntryWithoutLinkResolution<T>: Entry<T>

Type parameters

  • T

EnvironmentLink

EnvironmentLink: Link<"Environment">

GetGlobalOptions

GetGlobalOptions: (globalOptions?: GlobalOptionsParams) => Required<GlobalOptionsParams>

Type declaration

    • (globalOptions?: GlobalOptionsParams): Required<GlobalOptionsParams>

    • Parameters

      • Optional globalOptions: GlobalOptionsParams

      Returns Required<GlobalOptionsParams>

LinkType

LinkType: "Space" | "ContentType" | "Environment" | "Entry" | "Tag" | "User"

LocaleCode

LocaleCode: string

LocaleCollection

LocaleCollection: ContentfulCollection<Locale>

Metadata

Metadata: { tags: { sys: TagLink }[] }

Type declaration

SpaceLink

SpaceLink: Link<"Space">

Tag

Tag: { name: string; sys: TagSys }

Type declaration

TagCollection

TagCollection: ContentfulCollection<Tag>

TagLink

TagLink: Link<"Tag">

UserLink

UserLink: Link<"User">

createClient