LogoLogo
Home
  • Documentation
  • Developers
  • The Venue Developer Documentation
  • Next.js SDK
    • React Components
      • VenueContent
      • VenueImage
    • reference
      • Index
      • functions
        • VenueContent
        • VenueImage
        • getEvent
        • getEvents
        • getLocalizedContent
        • getPage
        • getPages
        • getProduct
        • getProducts
        • getProfile
        • getProfileEvents
        • getProfiles
        • getSite
        • setConfig
      • interfaces
        • NodeHandlers
        • NodeProps
        • RenderNode
      • type-aliases
        • ContentStyles
        • Event
        • GetEventData
        • GetEventError
        • GetEventResponse
        • GetEventsData
        • GetEventsError
        • GetEventsResponse
        • GetPageData
        • GetPageError
        • GetPageResponse
        • GetPagesData
        • GetPagesError
        • GetPagesResponse
        • GetProductData
        • GetProductError
        • GetProductResponse
        • GetProductsData
        • GetProductsError
        • GetProductsResponse
        • GetProfileData
        • GetProfileError
        • GetProfileEventsData
        • GetProfileEventsError
        • GetProfileEventsResponse
        • GetProfileResponse
        • GetProfilesData
        • GetProfilesError
        • GetProfilesResponse
        • GetSiteData
        • GetSiteError
        • GetSiteResponse
        • LocalizedContent
        • Location
        • MediaItem
        • NodeHandler
        • Page
        • Product
        • ProductVariant
        • Profile
        • Site
        • SiteSettings
        • TicketOnEvent
        • publishState
        • recordType
  • TypeScript SDK
    • reference
      • Index
      • functions
        • getEvent
        • getEvents
        • getLocalizedContent
        • getPage
        • getPages
        • getProduct
        • getProducts
        • getProfile
        • getProfileEvents
        • getProfiles
        • getSite
        • setConfig
      • type-aliases
        • Event
        • GetEventData
        • GetEventError
        • GetEventResponse
        • GetEventsData
        • GetEventsError
        • GetEventsResponse
        • GetPageData
        • GetPageError
        • GetPageResponse
        • GetPagesData
        • GetPagesError
        • GetPagesResponse
        • GetProductData
        • GetProductError
        • GetProductResponse
        • GetProductsData
        • GetProductsError
        • GetProductsResponse
        • GetProfileData
        • GetProfileError
        • GetProfileEventsData
        • GetProfileEventsError
        • GetProfileEventsResponse
        • GetProfileResponse
        • GetProfilesData
        • GetProfilesError
        • GetProfilesResponse
        • GetSiteData
        • GetSiteError
        • GetSiteResponse
        • LocalizedContent
        • Location
        • MediaItem
        • Page
        • Product
        • ProductVariant
        • Profile
        • Site
        • SiteSettings
        • TicketOnEvent
        • publishState
        • recordType
  • REST API
    • Api
      • V2
        • Public
          • Events
          • Pages
          • Products
          • Site
          • Profiles
            • Events
Powered by GitBook
On this page
Export as PDF

TypeScript SDK

Last updated 4 months ago

This package is the core of the Venue CMS TypeScript SDK.

To get started, you can install the SDK by running:

npm install @venuecms/sdk

Examples are strewn throughout the SDK reference which you can browse in the table of contents on the left.

If you are interested in Next.js make sure to use the @venuecms/sdk-next to take advantage of some extra optimizations and React components. The core SDK is included in that package as well so the reference will still apply.

For an example of a fully-built minimal application using this SDK, check out our template which we use in production and update frequently .

here