Exports

Type aliases

Record

Ƭ Record: object

Record items from a query or queryMore request.

property type The Salesforce Object type.

property fields A JavaScript object with all fields from the returned records. Each key in field is case insensitive, so the getters and setters for each key/value pair ignore casing when getting and setting the fields.

property binaryFields An optional JavaScript Object with unencoded binary content buffers to create the record with. Each key in binaryFields is case insensitive, so the getters and setters for each key/value pair ignore casing when getting and setting the fields.

Type declaration

Name	Type
`binaryFields?`	{ `[key: string]`: `Buffer`; }
`fields`	object
`type`	string

RecordForCreate

Ƭ RecordForCreate: object

Creates a single record for create or registers a record creation for the UnitOfWork and returns a ReferenceId.

property type The Salesforce Object type.

property fields A JavaScript Object for the fields that the record will be created with. The keys in the object are case insensitive.

Type declaration

Name	Type
`binaryFields?`	{ `[key: string]`: `Buffer`; }
`fields`	object
`type`	string

RecordForUpdate

Ƭ RecordForUpdate: object

Creates a single record for update or registers a record update for the UnitOfWork and returns a ReferenceId.

property type The Salesforce Object type.

property fields A JavaScript Object for the fields that the record will be updated with. The keys in the object are case sensitive and must be lowercase.

Type declaration

Name	Type
`binaryFields?`	{ `[key: string]`: `Buffer`; }
`fields`	object
`fields.id`	string
`type`	string

ReferenceId

Ƭ ReferenceId: string

References a record that will be created, deleted, or modified in the future.

SalesforceFunction

Ƭ SalesforceFunction<A, B>: (event: InvocationEvent<A>, context: Context, logger: Logger) => Promise<B> | B

Main interface for Salesforce Functions.

Type parameters

Name
`A`
`B`

Type declaration

▸ (event: InvocationEvent<A>, context: Context, logger: Logger): Promise<B> | B

Parameters

Name	Type
`event`	InvocationEvent<A>
`context`	Context
`logger`	Logger

Returns: Promise<B> | B

Product Retirement Announcement

Salesforce Functions is no longer available for purchase or renewal. To preserve the capabilities that Salesforce Functions provided to your org, deploy an alternative solution before your existing order term ends. See Salesforce Functions Retirement for more information on migrating your functions. Contact your Salesforce Account Executive for more information on Heroku.