Deprecate CancellationToken, ClientMetadata and ClientMetadataOptions types

XMLWordPrintableJSON

    • 2
    • Not Needed
    • None
    • 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... node driver user
      I want... the unused CancellationToken, ClientMetadata and ClientMetadataOptions types to be deprecated and removed
      So that... the TypeScript interface to the driver provides actually useful options

      User Experience

      • CancellationToken, ClientMetadata and ClientMetadataOptions types are marked deprecated in our API docs

      Dependencies

      Risks/Unknowns

      • N/A

      Acceptance Criteria

      Implementation Requirements

      • Add `@deprecated` tag to the CancellationToken type, and ClientMetadata and ClientMetadataOptions types

      Testing Requirements

      • Merge updated docs changes and ensure all types are marked deprecated

      Documentation Requirements

      • This is an API docs change

      Follow Up Requirements

      • N/A

        1.
        		 Validation NODE-7003 Sub-task Closed Bailey Pearson  

            Assignee:
            Durran Jordan
            Reporter:
            Daria Pardue
            Bailey Pearson
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: