Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
By Philipp Burckhardt - Oct 17, 2024
@layers.digital/layers-portal-sdk
Advanced tools
@layers.digital/layers-portal-sdk
O LayersPortal é uma camada de integração que permite que seu app seja acessado dentro do ecossistema Layers.
Layers Portal SDK
O LayersPortal é uma camada de integração que permite que seu app seja acessado dentro do ecossistema Layers.
Você pode encontrar tudo o que precisa saber através da documentação da Layers.
Instalação
Para a instalação, certifique-se de estar utilizando o Node.js
A instalação é feita pelo comando:
npm install @layers.digital/layers-portal-sdk
Logo após instalado, algumas configurações do portal devem ser definidas para que a Layers consiga se conectar corretamente com o app. Você pode coloca-los no do seu index, como por exemplo:
<html>
<head>
<script>
window.LayersPortalOptions = {
appId: String, // Identificador do app
insidePortalOnly: Boolean, // O app deve ser acessado apenas através da Layers?
}
</script>
...
</head>
<body>
...
</body>
</html>
Com o pacote @layers.digital/layers-portal-sdk instalado e com as configurações feitas, você agora poderá importar o pacote no inicio do ciclo do seu app para que ele seja iniciado corretamente, como mostrado no exemplo:
// main.js
...
import '@layers.digital/layers-portal-sdk';
...
O LayersPortal agora pode ser acessado através da propriedade de window pelo JavaScript.
Exemplos
Exemplos de uso de alguns métodos do LayersPortal:
const { LayersPortal } = window; // Pegando o LayersPortal da propriedade window
await LayersPortal.readyPromise; // Esperando a lib ser importada com sucesso
const { userId, communityId } = LayersPortal; // Pegando as informações básicas do usuário conectado
console.log({ userId, communityId });
const { LayersPortal } = window;
LayersPortal('download', { url: 'someUrl', filename: 'someFile' }); // Requisitando que a Layers faça o download de um arquivo
TypeScript
O pacote do LayersPortal já vem com as interfaces que você precisa, para utiliza-las, importe as interfaces necessárias no seu arquivo de declaração global:
import { LayersPortalOptions, LayersPortalSDK } from '@layers.digital/layers-portal-sdk';
declare global {
interface Window {
LayersPortal: LayersPortalSDK
LayersPortalOptions: LayersPortalOptions
}
}
FAQs
O LayersPortal é uma camada de integração que permite que seu app seja acessado dentro do ecossistema Layers.
We found that @layers.digital/layers-portal-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Package last updated on 22 Jan 2024
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Product
Enhancing Open-Source Compliance: Introducing Socket’s Advanced License Analysis
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
By Christopher Bailey - Oct 17, 2024
Product
Introducing Socket Optimize
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.
By John-David Dalton - Oct 16, 2024