Class RecordReference<S, N, InputRecord, RetrieveRecord>

constructor

• new RecordReference<
      S extends Schema,
      N extends string,
      InputRecord extends
          Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<
          SObjectRecord<S, N, "*", Record, {}>,
      >,
      RetrieveRecord extends
          SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>,
  >(
      conn: Connection<S>,
      type: N,
      id: string,
  ): RecordReference<S, N, InputRecord, RetrieveRecord>

  Type Parameters

  • S extends Schema
  • N extends string
  • InputRecord extends Partial<SObjectRecord<S, N, "*", Record, {}>> = Partial<SObjectRecord<S, N, "*", Record, {}>>
  • RetrieveRecord extends SObjectUpdateRecord<S, N> = SObjectUpdateRecord<S, N>

  Parameters

  • conn: Connection<S>
  • type: N
  • id: string

  Returns RecordReference<S, N, InputRecord, RetrieveRecord>

_conn

del

delete

id

type

blob

• blob(fieldName: string): Duplex

  Get blob field as stream

  Parameters

  • fieldName: string

    Blob field name

  Returns Duplex

destroy

• destroy(options?: DmlOptions): Promise<SaveResult>

  Delete record field

  Parameters

  • Optionaloptions: DmlOptions

  Returns Promise<SaveResult>

retrieve

• retrieve(options?: RetrieveOptions): Promise<RetrieveRecord>

  Retrieve record field information

  Parameters

  • Optionaloptions: RetrieveOptions

  Returns Promise<RetrieveRecord>

update

• update(record: InputRecord, options?: DmlOptions): Promise<SaveResult>

  Update record field information

  Parameters

  • record: InputRecord
  • Optionaloptions: DmlOptions

  Returns Promise<SaveResult>