Interface DoipClient

Returns Promise<DoipResponse>

A promise that resolves to a DoipResponse. The caller is responsible for closing the DoipResponse.

const request = {
    targetId: 'service',
    operationId: '0.DOIP/Op.Hello'
};
const response = await client.performOperation(request);
console.log(await response.asJson()); // asJson closes the response
Copy

Returns Promise<DoipResponse>

A promise that resolves to a DoipResponse. The caller is responsible for closing the DoipResponse.

const response = await client.performOperation('service', '0.DOIP/Op.Hello');
console.log(await response.asJson()); // asJson closes the response
Copy

Returns Promise<void>

Returns string

The ID for the service

Returns Promise<DigitalObject>

A promise that resolves to a DigitalObject containing information about the service

const serviceInfo = await client.hello();
console.log(serviceInfo);
Copy

Returns Promise<null | DigitalObject>

A promise that resolves to the retrieved DigitalObject, or null if not found

const object = await client.retrieve('20.500.123/1');
if (object) {
  console.log(object.attributes.content);
}
Copy

Returns Promise<string[]>

A promise that resolves to an array of operation IDs

// List operations for a specific object
const operations = await client.listOperations('20.500.123/1');
console.log(operations);

// List operations for the service using the default service ID
const serviceOps = await client.listOperations('service');
console.log(serviceOps);
Copy

Returns Promise<SearchResults<string>>

A promise that resolves to SearchResults which among other properties is an async iterable iterator of digital object IDs The caller is responsible for closing the SearchResults.

const results = await client.searchIds('type:Document');
try {
  for await (const id of results) {
    console.log(id);
  }
} finally {
  await results.close();
}
Copy

Returns Promise<SearchResults<DigitalObject>>

A promise that resolves to SearchResults which among other properties is an async iterable iterator of digital objects. The caller is responsible for closing the SearchResults.

const results = await client.search('type:Document');
console.log(`Number of results: ${results.size}`);
try {
  for await (const object of results) {
    console.log(`${object.id}: ${object.attributes.content.name}`);
  }
} finally {
  await results.close();
}
Copy

Returns Promise<void>

A promise that resolves when the deletion is complete

await client.delete('20.500.123/1');
Copy

Returns Promise<null | Body>

A promise that resolves to the element body, or null if not found

// Get the bytes of a binary element payload
const elementBody = await client.retrieveElementBytes('20.500.123/1', 'attachment-binary');
if (elementBody) {
    const buffer = await elementBody.arrayBuffer();
    const bytes = new Uint8Array(buffer);
    console.log(`length: ${bytes.length}`);
    // process bytes
}

// Get text from a text element body
const elementBody = await client.retrieveElementBytes('20.500.123/1', 'attachment-text');
if (elementBody) {
    const text = await elementBody.text();
    console.log(text);
}
Copy

Returns Promise<null | Body>

A promise that resolves to the partial element body, or null if not found

// Retrieve the first 1000 bytes of a binary element body
const elementBody = await client.retrievePartialElementBytes('20.500.123/1', 'attachment-binary', 0, 999);
if (elementBody) {
    const buffer = await elementBody.arrayBuffer();
    const bytes = new Uint8Array(buffer);
    console.log(`length: ${bytes.length}`);
}

// Retrieve bytes from the middle of a text element body
const elementBody = await client.retrievePartialElementBytes('20.500.123/1', 'text', 2, 5);
if (elementBody) {
    console.log(await elementBody.text());
}
Copy

Returns Promise<DigitalObject>

A promise that resolves to the created digital object

const object = {
  type: 'Document',
  attributes: {
    content: {
      name: 'Example Document'
    }
  }
};
const createdObject = await client.create(object);
console.log(createdObject.id);
Copy

Returns Promise<DigitalObject>

A promise that resolves to the updated digital object

const object = await client.retrieve('20.500.123/1');
if (object) {
  object.attributes.content.name = 'Updated Example Document';
  const updatedObject = await client.update(object);
  console.log(updatedObject.attributes.content.name);
}
Copy