TypeScript: typing an httprequest with diverse return types



.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty height:90px;width:728px;box-sizing:border-box;








1















I'm fairly familiar with Javascript, but having some issues recreating some of the patterns I use in TypeScript, because I'm not sure how to type functions that could have diverse JSON fields. For example, I was trying to write a simple http request function that I could use:



async function requestTest (options: https.RequestOptions) {
const prom = new Promise((resolve, reject) => {
https.request(options, (res) =>
res.on('data', (d) =>
if (d.status == 200)
resolve(d)

reject('failed')
)
)
return await prom


However, if I actually want to use this function, say query a database and get back a result where the "data" field on the response will contain data of a known structure that I have an interface declared for:



const getData = (opts): ISomeStructure => 
return requestTest(opts)



I get an error of the type:



Type 'Promise<>' is not assignable to type 'ISomeStructure'.



How do I declare the types in such a way as to tell typescript that in this case, I am expecting the http response to have a key that contains an ISomeStructure JSON object?










share|improve this question






























    1















    I'm fairly familiar with Javascript, but having some issues recreating some of the patterns I use in TypeScript, because I'm not sure how to type functions that could have diverse JSON fields. For example, I was trying to write a simple http request function that I could use:



    async function requestTest (options: https.RequestOptions) {
    const prom = new Promise((resolve, reject) => {
    https.request(options, (res) =>
    res.on('data', (d) =>
    if (d.status == 200)
    resolve(d)

    reject('failed')
    )
    )
    return await prom


    However, if I actually want to use this function, say query a database and get back a result where the "data" field on the response will contain data of a known structure that I have an interface declared for:



    const getData = (opts): ISomeStructure => 
    return requestTest(opts)



    I get an error of the type:



    Type 'Promise<>' is not assignable to type 'ISomeStructure'.



    How do I declare the types in such a way as to tell typescript that in this case, I am expecting the http response to have a key that contains an ISomeStructure JSON object?










    share|improve this question


























      1












      1








      1








      I'm fairly familiar with Javascript, but having some issues recreating some of the patterns I use in TypeScript, because I'm not sure how to type functions that could have diverse JSON fields. For example, I was trying to write a simple http request function that I could use:



      async function requestTest (options: https.RequestOptions) {
      const prom = new Promise((resolve, reject) => {
      https.request(options, (res) =>
      res.on('data', (d) =>
      if (d.status == 200)
      resolve(d)

      reject('failed')
      )
      )
      return await prom


      However, if I actually want to use this function, say query a database and get back a result where the "data" field on the response will contain data of a known structure that I have an interface declared for:



      const getData = (opts): ISomeStructure => 
      return requestTest(opts)



      I get an error of the type:



      Type 'Promise<>' is not assignable to type 'ISomeStructure'.



      How do I declare the types in such a way as to tell typescript that in this case, I am expecting the http response to have a key that contains an ISomeStructure JSON object?










      share|improve this question
















      I'm fairly familiar with Javascript, but having some issues recreating some of the patterns I use in TypeScript, because I'm not sure how to type functions that could have diverse JSON fields. For example, I was trying to write a simple http request function that I could use:



      async function requestTest (options: https.RequestOptions) {
      const prom = new Promise((resolve, reject) => {
      https.request(options, (res) =>
      res.on('data', (d) =>
      if (d.status == 200)
      resolve(d)

      reject('failed')
      )
      )
      return await prom


      However, if I actually want to use this function, say query a database and get back a result where the "data" field on the response will contain data of a known structure that I have an interface declared for:



      const getData = (opts): ISomeStructure => 
      return requestTest(opts)



      I get an error of the type:



      Type 'Promise<>' is not assignable to type 'ISomeStructure'.



      How do I declare the types in such a way as to tell typescript that in this case, I am expecting the http response to have a key that contains an ISomeStructure JSON object?







      typescript http es6-promise






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Nov 15 '18 at 15:13







      mstorkson

















      asked Nov 15 '18 at 15:07









      mstorksonmstorkson

      620314




      620314






















          1 Answer
          1






          active

          oldest

          votes


















          1














          There are two problems with your code, one related to async code, the other related to types.



          The async issue is that you return requestTest(opts) while you declare that your function will return ISomeStructure. Since requestTest retruns a Promise you should return a Promis<ISomeStructure> from getData, since the data returned by requestTest will not be immediately available to return directly.



          The second problem is that you should allow the return type of the request to be specified as a type parameter on requestTest that way your function can be used for any returned type.



          function requestTest<T>(options: https.RequestOptions) 
          return new Promise<T>((resolve, reject) =>
          https.request(options, (res) =>
          res.on('data', (d) =>
          if (d.status == 200)
          resolve(d)

          reject('failed')
          )
          )
          );


          const getData = (opts: https.RequestOptions): Promise<ISomeStructure> =>
          return requestTest<ISomeStructure>(opts)






          share|improve this answer























            Your Answer






            StackExchange.ifUsing("editor", function ()
            StackExchange.using("externalEditor", function ()
            StackExchange.using("snippets", function ()
            StackExchange.snippets.init();
            );
            );
            , "code-snippets");

            StackExchange.ready(function()
            var channelOptions =
            tags: "".split(" "),
            id: "1"
            ;
            initTagRenderer("".split(" "), "".split(" "), channelOptions);

            StackExchange.using("externalEditor", function()
            // Have to fire editor after snippets, if snippets enabled
            if (StackExchange.settings.snippets.snippetsEnabled)
            StackExchange.using("snippets", function()
            createEditor();
            );

            else
            createEditor();

            );

            function createEditor()
            StackExchange.prepareEditor(
            heartbeatType: 'answer',
            autoActivateHeartbeat: false,
            convertImagesToLinks: true,
            noModals: true,
            showLowRepImageUploadWarning: true,
            reputationToPostImages: 10,
            bindNavPrevention: true,
            postfix: "",
            imageUploader:
            brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
            contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
            allowUrls: true
            ,
            onDemand: true,
            discardSelector: ".discard-answer"
            ,immediatelyShowMarkdownHelp:true
            );



            );













            draft saved

            draft discarded


















            StackExchange.ready(
            function ()
            StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53322366%2ftypescript-typing-an-httprequest-with-diverse-return-types%23new-answer', 'question_page');

            );

            Post as a guest















            Required, but never shown

























            1 Answer
            1






            active

            oldest

            votes








            1 Answer
            1






            active

            oldest

            votes









            active

            oldest

            votes






            active

            oldest

            votes









            1














            There are two problems with your code, one related to async code, the other related to types.



            The async issue is that you return requestTest(opts) while you declare that your function will return ISomeStructure. Since requestTest retruns a Promise you should return a Promis<ISomeStructure> from getData, since the data returned by requestTest will not be immediately available to return directly.



            The second problem is that you should allow the return type of the request to be specified as a type parameter on requestTest that way your function can be used for any returned type.



            function requestTest<T>(options: https.RequestOptions) 
            return new Promise<T>((resolve, reject) =>
            https.request(options, (res) =>
            res.on('data', (d) =>
            if (d.status == 200)
            resolve(d)

            reject('failed')
            )
            )
            );


            const getData = (opts: https.RequestOptions): Promise<ISomeStructure> =>
            return requestTest<ISomeStructure>(opts)






            share|improve this answer



























              1














              There are two problems with your code, one related to async code, the other related to types.



              The async issue is that you return requestTest(opts) while you declare that your function will return ISomeStructure. Since requestTest retruns a Promise you should return a Promis<ISomeStructure> from getData, since the data returned by requestTest will not be immediately available to return directly.



              The second problem is that you should allow the return type of the request to be specified as a type parameter on requestTest that way your function can be used for any returned type.



              function requestTest<T>(options: https.RequestOptions) 
              return new Promise<T>((resolve, reject) =>
              https.request(options, (res) =>
              res.on('data', (d) =>
              if (d.status == 200)
              resolve(d)

              reject('failed')
              )
              )
              );


              const getData = (opts: https.RequestOptions): Promise<ISomeStructure> =>
              return requestTest<ISomeStructure>(opts)






              share|improve this answer

























                1












                1








                1







                There are two problems with your code, one related to async code, the other related to types.



                The async issue is that you return requestTest(opts) while you declare that your function will return ISomeStructure. Since requestTest retruns a Promise you should return a Promis<ISomeStructure> from getData, since the data returned by requestTest will not be immediately available to return directly.



                The second problem is that you should allow the return type of the request to be specified as a type parameter on requestTest that way your function can be used for any returned type.



                function requestTest<T>(options: https.RequestOptions) 
                return new Promise<T>((resolve, reject) =>
                https.request(options, (res) =>
                res.on('data', (d) =>
                if (d.status == 200)
                resolve(d)

                reject('failed')
                )
                )
                );


                const getData = (opts: https.RequestOptions): Promise<ISomeStructure> =>
                return requestTest<ISomeStructure>(opts)






                share|improve this answer













                There are two problems with your code, one related to async code, the other related to types.



                The async issue is that you return requestTest(opts) while you declare that your function will return ISomeStructure. Since requestTest retruns a Promise you should return a Promis<ISomeStructure> from getData, since the data returned by requestTest will not be immediately available to return directly.



                The second problem is that you should allow the return type of the request to be specified as a type parameter on requestTest that way your function can be used for any returned type.



                function requestTest<T>(options: https.RequestOptions) 
                return new Promise<T>((resolve, reject) =>
                https.request(options, (res) =>
                res.on('data', (d) =>
                if (d.status == 200)
                resolve(d)

                reject('failed')
                )
                )
                );


                const getData = (opts: https.RequestOptions): Promise<ISomeStructure> =>
                return requestTest<ISomeStructure>(opts)







                share|improve this answer












                share|improve this answer



                share|improve this answer










                answered Nov 15 '18 at 15:17









                Titian Cernicova-DragomirTitian Cernicova-Dragomir

                74.3k35371




                74.3k35371





























                    draft saved

                    draft discarded
















































                    Thanks for contributing an answer to Stack Overflow!


                    • Please be sure to answer the question. Provide details and share your research!

                    But avoid


                    • Asking for help, clarification, or responding to other answers.

                    • Making statements based on opinion; back them up with references or personal experience.

                    To learn more, see our tips on writing great answers.




                    draft saved


                    draft discarded














                    StackExchange.ready(
                    function ()
                    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53322366%2ftypescript-typing-an-httprequest-with-diverse-return-types%23new-answer', 'question_page');

                    );

                    Post as a guest















                    Required, but never shown





















































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown

































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown







                    Popular posts from this blog

                    How to how show current date and time by default on contact form 7 in WordPress without taking input from user in datetimepicker

                    Syphilis

                    Darth Vader #20