Introdução
Nesse guia, aprenderemos a utilizar o JS SDK do Starlight, uma ferramenta oficial que automatiza o processo de integração de sites e aplicações JavaScript com as APIs do Starlight.
O JS SDK pode ser usado em qualquer aplicação JavaScript e TypeScript. Porém, se sua aplicação usa React, você pode utilizar o Starlight React SDK, que provê componentes React que facilitam a integração com o Starlight, além de todas as funcionalidades do JS SDK.
Além desse guia, você também pode verificar a referência de todos os objetos e métodos do SDK na seção API. Você pode sempre acessar a seção API no menu do topo desse site, ou no menu de hambúrguer em dispositivos mobile. Além disso, várias páginas desse guia contém links para visualizar páginas da API relacionadas ao conteúdo.
Instalação
Para começar a utilizar o JS SDK, instale-o no seu projeto:
- npm
- yarn
npm install @starlightcms/js-sdk
yarn add @starlightcms/js-sdk
Depois de instalado, você precisa configurar qual área de trabalho deve ser utilizada para requisitar dados. Saiba mais na página sobre o Cliente desse guia.
TypeScript
O JS SDK é escrito em TypeScript e "tipa" corretamente a maioria dos seus métodos, o que é útil mesmo que você use JavaScript comum na sua aplicação, já que sua IDE pode usar esses tipos para lhe ajudar no desenvolvimento.
Todos os tipos exportados pelo JS SDK são detalhados na seção da API desse site.