Opções de configuração dadas para InitializeServerApp()
Signature:
export interface FirebaseServerAppSettings extends FirebaseAppSettings
Estende: FirebaseAppSettings
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
authIdToken | string | Um token de ID de autenticação opcional usado para retomar uma sessão de usuário conectada em um ambiente de execução do cliente.Invocar getAuth com um FirebaseServerApp configurado com um authIdToken validado causa uma tentativa automática de fazer login do usuário que o authIdToken representa. O token precisa ter sido criado recentemente para que esta operação seja bem-sucedida.Se o token falhar na verificação local ou se o serviço Auth falhar na validação durante a inicialização do SDK do Auth, um aviso será registrado no console e o SDK do Auth não vai fazer login do usuário na inicialização.Se um usuário fizer login, o callback onAuthStateChanged da instância de autenticação será invocado com o objeto User conforme os fluxos de autenticação padrão. No entanto, os objetos User criados por uma authIdToken não têm um token de atualização. Falha nas operações refreshToken . |
name | indefinido | Não há operação getApp() para FirebaseServerApp . Portanto, o nome não é relevante para aplicativos. No entanto, ela pode ser usada internamente e é declarada aqui para que FirebaseServerApp esteja em conformidade com a interface FirebaseApp . |
releaseOnDeref | objeto | Um objeto opcional. Se fornecido, o SDK do Firebase usa um objeto FinalizationRegistry para monitorar o status da coleta de lixo do objeto fornecido. O SDK do Firebase libera a referência na instância FirebaseServerApp quando o objeto releaseOnDeref fornecido é coletado da lixeira.Use esse campo para reduzir a sobrecarga de gerenciamento de memória do aplicativo. Se fornecido, um app em execução em uma passagem SSR não precisa realizar a limpeza de FirebaseServerApp , desde que o objeto de referência seja excluído (por exemplo, fora do escopo da SSR).Se um objeto não for fornecido, o aplicativo precisará limpar a instância de FirebaseServerApp invocando deleteApp .Se o aplicativo fornecer um objeto nesse parâmetro, mas o aplicativo for executado em um mecanismo JavaScript que antecede o suporte de FinalizationRegistry , será gerado um erro na instância FirebaseServerApp v4. |
FirebaseServerAppSettings.authIdToken
Um token de ID de autenticação opcional usado para retomar uma sessão de usuário conectada de um ambiente de execução do cliente.
Invocar getAuth
com um FirebaseServerApp
configurado com um authIdToken
validado causa uma tentativa automática de fazer login do usuário que o authIdToken
representa. O token precisa ter sido criado recentemente para que a operação seja bem-sucedida.
Se o token falhar na verificação local ou se o serviço Auth falhar ao validá-lo quando o SDK do Auth for inicializado, um aviso será registrado no console e o SDK do Auth não fará o login de um usuário na inicialização.
Se um usuário fizer login, o callback onAuthStateChanged
da instância de autenticação será invocado com o objeto User
, de acordo com os fluxos de autenticação padrão. No entanto, os objetos User
criados por uma authIdToken
não têm um token de atualização. Falha nas operações refreshToken
.
Signature:
authIdToken?: string;
FirebaseServerAppSettings.name
Não há operação getApp()
para FirebaseServerApp
. Portanto, o nome não é relevante para aplicativos. No entanto, ela pode ser usada internamente e é declarada aqui para que FirebaseServerApp
esteja em conformidade com a interface FirebaseApp
.
Signature:
name?: undefined;
FirebaseServerAppSettings.releaseOnDeref
Um objeto opcional. Se fornecido, o SDK do Firebase usa um objeto FinalizationRegistry
para monitorar o status da coleta de lixo do objeto fornecido. O SDK do Firebase libera a referência na instância FirebaseServerApp
quando o objeto releaseOnDeref
fornecido é coletado da lixeira.
Use esse campo para reduzir a sobrecarga de gerenciamento de memória do aplicativo. Se fornecido, um app em execução em uma passagem de SSR não precisará realizar a limpeza de FirebaseServerApp
, desde que o objeto de referência seja excluído (por exemplo, fora do escopo da SSR).
Se um objeto não for fornecido, o aplicativo precisará limpar a instância do FirebaseServerApp
invocando deleteApp
.
Se o aplicativo fornecer um objeto nesse parâmetro, mas for executado em um mecanismo JavaScript anterior ao suporte a FinalizationRegistry
(introduzido no nó v14.6.0, por exemplo), um erro será gerado na inicialização de FirebaseServerApp
.
Signature:
releaseOnDeref?: object;