Missing documentation for tls.parseCertString #14193

Activity

1. mscdex

   added

   docIssues and PRs related to Node.js documentation.Issues and PRs related to Node.js documentation.

   tlsIssues and PRs related to the tls subsystem.Issues and PRs related to the tls subsystem.

   on Jul 12, 2017
2. bnoordhuis commented on Jul 12, 2017

   

   bnoordhuis

   on Jul 12, 2017

   Member

   More actions

   That function was exposed by accident more than anything else in commit af80e7b from 2013. It's probably better to move it to lib/internal than promote it to official API.

   cc @indutny

   👍React with 👍1Reacted by Sam Roberts
3. chrisbroome commented on Jul 12, 2017

   

   chrisbroome

   on Jul 12, 2017

   Last edited by chrisbroome

   Author

   More actions

   @bnoordhuis Makes sense to me.

   Also, after looking it what it actually does, it's also almost identical to calling

   querystring.parse(str, '\n', '=')

   with the one exception being when the string is invalid:

   querystring.parse('invalidCertString', '\n', '=')
   // yields {invalidCertString: ''} instead of {}
4. XadillaX commented on Jul 12, 2017

   

   XadillaX

   on Jul 12, 2017

   Contributor

   More actions

   If we move it to internal, I think it's a semver major.
5. sam-github commented on Jul 12, 2017

   

   sam-github

   on Jul 12, 2017

   Contributor

   More actions

   @chrisbroome did you call this API? for what purpose? It parses a format that doesn't appear to ever be produced by a public API, I don't see how it could be useful.

   Calling it semver-major is safe, lets not doc, and move to internal for 9.x
6. chrisbroome commented on Jul 12, 2017

   

   chrisbroome

   on Jul 12, 2017

   Author

   More actions

   I never actually used the API in production code. Basically I was playing around in the REPL exploring what was available in the tls module. I just typed tls.<tab>, saw parseCertString, and wanted to know what its purpose was (I thought maybe it was a function that let you extract information from base64-encoded .pem files). Anyway, I went to the documentation, but the function wasn't there, so I decided to open the issue.
7. sam-github commented on Jul 12, 2017

   

   sam-github

   on Jul 12, 2017

   Contributor

   More actions

   OK. I don't personally think we should document something only to remove it in the next major. If we do document it, it should be doc-deprecated at least.

   👍React with 👍2Reacted by Khaidi Chu and Chris Broome
8. XadillaX commented on Jul 13, 2017

   

   XadillaX

   on Jul 13, 2017

   Contributor

   More actions

   @sam-github I agree to remove it in the next major and document it now for deprecated.
9. XadillaX

   added a commit that references this issue on Jul 13, 2017

   doc: add tls.parseCertString()

   ...

   d61d561
10. bnoordhuis commented on Jul 13, 2017

    

    bnoordhuis

    on Jul 13, 2017

    Member

    More actions

    I'd do the following:

    1. Don't document it.
    2. Move it to lib/internal and leave a stub function in lib/tls.js that prints a deprecation warning.
    3. In the next major or the one after that, remove the stub.
11. XadillaX

    added a commit that references this issue on Jul 13, 2017

    tls: move parseCertString to internal

    ...

    1a031f2
12. XadillaX commented on Jul 13, 2017

    

    XadillaX

    on Jul 13, 2017

    Contributor

    More actions

    @bnoordhuis I've created another PR #14218 to move the function to internal.
13. 1 remaining item

    Load more
14. XadillaX

    added 3 commits that reference this issue on Aug 4, 2017

    tls: deprecate parseCertString & move to internal

    ...

    6a8b5b2

    doc, tls: mark parseCertString() as deprecated

    ...

    d82f064
15. BridgeAR

    added a commit that references this issue on Sep 8, 2017

    doc, tls: mark parseCertString() as deprecated

    ...

    703a3b5
16. XadillaX

    added a commit that references this issue on Sep 8, 2017

    tls: deprecate parseCertString & move to internal

    ...

    6b12b7e
17. addaleax

    added a commit that references this issue on Sep 13, 2017

    doc, tls: mark parseCertString() as deprecated

    ...

    e322be6
18. BridgeAR

    added a commit that references this issue on Sep 13, 2017

    tls: deprecate parseCertString & move to internal

    ...

    468110b
19. addaleax

    added a commit that references this issue on Sep 17, 2017

    tls: deprecate parseCertString & move to internal

    ...

    bf34edf
20. jasnell

    added a commit that references this issue on Sep 20, 2017

    doc, tls: mark parseCertString() as deprecated

    ...

    b09eeb4
21. Qard

    added a commit that references this issue on Sep 21, 2017

    tls: deprecate parseCertString & move to internal

    ...

    68e7c08
22. bnoordhuis commented on May 28, 2018

    

    bnoordhuis

    on May 28, 2018

    Member

    More actions

    Closing, #14249 was merged last year.
23. bnoordhuis

    closed this as completedon May 28, 2018