@types/jsforce/record.d.ts

TypeScript definitions for jsforce

import { Stream } from "stream";

import { Connection } from "./connection";
import { RecordResult } from "./record-result";
import { SalesforceId } from "./salesforce-id";

export class RecordReference<T = any> {
    constructor(conn: Connection, type: string, id: SalesforceId);

    blob(fieldName: string): Stream;
    del(options?: Object, callback?: (err: Error, result: RecordResult) => void): Promise<RecordResult>;
    delete(options?: Object, callback?: (err: Error, result: RecordResult) => void): Promise<RecordResult>;
    destroy(options?: Object, callback?: (err: Error, result: RecordResult) => void): Promise<RecordResult>;
    retrieve(options?: Object, callback?: (err: Error, record: Record<T>) => void): Promise<Record<T>>;
    update(
        record: Partial<T>,
        options?: Object,
        callback?: (err: Error, result: RecordResult) => void,
    ): Promise<RecordResult>;
}

export interface RecordAttributes {
    type: string;
    url: string;
}

export type Record<T = any> = {
    Id?: SalesforceId | undefined;
    attributes?: RecordAttributes | undefined;
} & T;