Share via


custom-functions-runtime package

Classes

CustomFunctions.Error

Use essa classe para lidar com erros e gravar mensagens de erro personalizadas.

Interfaces

CustomFunctions.CancelableInvocation

Fornece informações sobre a invocação de uma função personalizada cancelável. Uma função personalizada cancelável pode fornecer um manipulador para o evento onCanceled.

Para indicar que uma função é cancelável, no arquivo JSON de metadados, as opções de função devem especificar: { "cancelable": true }

Se o arquivo JSON de metadados estiver sendo gerado a partir de comentários JSDoc, inclua a marca @cancelable.

CustomFunctions.Invocation

Fornece informações sobre a invocação de uma função personalizada.

CustomFunctions.StreamingInvocation

Fornece informações sobre a invocação de uma função personalizada de streaming. Uma função personalizada de streaming pode fornecer resultados que podem ser alterados ao longo do tempo.

Chame setResult() uma ou mais vezes para fornecer o resultado em vez de retornar um resultado da função.

Enumerações

CustomFunctions.ErrorCode

Códigos de erro para funções personalizadas. Os códigos de erro serão exibidos na célula que invocou a função.

As mensagens de erro personalizadas aparecem além desses códigos de erro. As mensagens personalizadas são exibidas no menu indicador de erro, que é acessado pairando sobre o sinalizador de erro em cada célula com um erro.

Funções

CustomFunctions.associate(id, functionObject)

Associa a função JavaScript ao nome fornecido pela propriedade "id" no arquivo JSON de metadados.

CustomFunctions.associate(mappings)

Associa as funções JavaScript aos nomes dados pelas propriedades "id" no arquivo JSON de metadados.

Detalhes da função

CustomFunctions.associate(id, functionObject)

Associa a função JavaScript ao nome fornecido pela propriedade "id" no arquivo JSON de metadados.

export function associate(id: string, functionObject: Function): void;

Parâmetros

id

string

functionObject

Function

Retornos

void

CustomFunctions.associate(mappings)

Associa as funções JavaScript aos nomes dados pelas propriedades "id" no arquivo JSON de metadados.

export function associate(mappings: { [key: string]: Function }): void;

Parâmetros

mappings

{ [key: string]: Function }

Retornos

void