Options required in rewrapManyDataKey() TS signature

XMLWordPrintableJSON

    • Type: Bug
    • Resolution: Fixed
    • Priority: Unknown
    • 6.21.0
    • Affects Version/s: None
    • Component/s: None
    • 2
    • Not Needed
    • 🔵 Done
    • Hide

      Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.

      Show
      Create a copy of the Kickoff Template with the issue key (NODE-XXX) in the filename and share a link to the new doc via this field.
    • Not Needed
    • None
    • None
    • None
    • None
    • None
    • None

      Use Case

      As a nodejs driver user
      I want to be able to execute methods as they described
      So that I can rely on documentation & typescript types

       

      ```
* @example
* ```ts
* // rewrapping all data data keys (using a filter that matches all documents)
* const filter = {};
*
* const result = await clientEncryption.rewrapManyDataKey(filter);
* if (result.bulkWriteResult != null) {
* // keys were re-wrapped, results will be available in the bulkWrite object.
* }
*
```

      but options marked as required in the interface:

      ```
async rewrapManyDataKey(
filter: Filter<DataKey>,
options: ClientEncryptionRewrapManyDataKeyProviderOptions
): Promise<\{ bulkWriteResult?: BulkWriteResult }> {
```

      User Experience

      • Autogenerated documentation and typescript types match

      Dependencies

      • None

      Risks/Unknowns

      • None

      Acceptance Criteria

      Implementation Requirements

      • Mark options as optional

      Testing Requirements

      • TS test

      Documentation Requirements

      • N/A

      Follow Up Requirements

      • N/A

            Assignee:
            Sergey Zelenov
            Reporter:
            Sergey Zelenov
            Bailey Pearson
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: