Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-6887

Make cursor fluid API and options API equivalent

    • Type: Icon: Epic Epic
    • Resolution: Unresolved
    • Priority: Icon: Minor - P4 Minor - P4
    • None
    • Affects Version/s: None
    • Component/s: Cursors
    • Cursor API Equivalence
    • None
    • Hide
      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?
      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • To Do
    • 0
    • 0
    • 0
    • 100
    • None
    • None

      Use Case

      As a... Node.js user
      I want... the cursor fluid API and options API to be consistent and equivalent
      So that... I can confidently switch between them for whatever code flow serves me best

      User Experience

      • Assertions and validations performed inside chained methods should also apply to options usage

      Dependencies

      • None

      Risks/Unknowns

      • How will the change in assertions impact existing usage?
      • How can we best share the validation for re-use
      • When can/should we defer to server errors/validation?

      Acceptance Criteria

      Implementation Requirements

      • Consolidate and test chainable method behavior and options behavior to be equivalent
      • Ensure equivalent validations are performed for either usage
        • Address any order dependent options to be order agnostic (ex. tailable cursors can't have a sort, what happens when one is specified before the other?)

      Testing Requirements

      • Test every option that has an equivalent chain method results in the same validation and configuration of the cursor

      Documentation Requirements

      Follow Up Requirements

      • None

            Assignee:
            Unassigned Unassigned
            Reporter:
            neal.beeken@mongodb.com Neal Beeken
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              None
              None
              None
              None