Wondering what’s next for npm?Check out our public roadmap! »

    cloud-docs-shared-code
    TypeScript icon, indicating that this package has built-in type declarations

    3.3.3 • Public • Published
    master develop
    Build Status codebeat badge Build Status codebeat badge

    Kentico Cloud Documentation - Shared code

    This repository contains shared code from all of other Kentico Cloud Docs repositories.

    Shared functions

    Azure storage

    getBlobContainerName - Returns name of a blob container specified in an event grid event.

    getBlobFromStorage - Async function that returns content of an Azure blob as a JSON object.

    Kentico Cloud utils

    getRootCodenamesOfItem - Traverses structured content from Kentico Cloud and returns codenames of found root items. Requires:

    • item - data about the item where the traversal starts
    • allItems - items from Kentico Cloud project
    • rootItemTypes - types of the root content items

    Shared classes

    Configuration

    Contains configuration settings that are shared between the other Kentico Cloud Docs repositories:

    • azureAccountName
    • azureContainerName
    • azureStorageKey
    • searchAdminApiKey
    • searchAppId
    • searchIndexName
    • kenticoProjectId
    • securedApiKey
    • previewApiKey
    • docsWebsiteUrl

    Shared interfaces

    Contracts

    Event Grid - Specifies an Azure Event Grid schema, along with the options for passed data in the event's data property.

    Kentico Cloud - Contains an IWebhookContentItem that specifies data sent in a webhook reacting to a change in published content.

    Search - Contains a contract for records sent to IndexSync service.

    Reference

    Preprocessed models - Interfaces of preprocessed data models from Kentico Cloud. Those models are based on an OpenAPI Specification 3.0.2.

    How To Contribute

    Feel free to open a new issue where you describe your proposed changes, or even create a new pull request from your branch with proposed changes.

    Licence

    All the source codes are published under MIT licence.

    Keywords

    none

    Install

    npm i cloud-docs-shared-code

    DownloadsWeekly Downloads

    2

    Version

    3.3.3

    License

    MIT

    Unpacked Size

    27.9 kB

    Total Files

    29

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar