主頁 > 企業開發 > Typescript 回呼函式、事件偵聽的型別定義與注釋--拾人牙慧

Typescript 回呼函式、事件偵聽的型別定義與注釋--拾人牙慧

2023-02-23 08:17:34 企業開發

實際專案中會運到的 Typescript 回呼函式、事件偵聽的型別定義,如果剛碰到會一臉蒙真的,我就是

這是第一次我自己對 Typescript 記錄學習,所以得先說一下我與 Typescript 的孽緣

記得最早是在2014年遇上 Typescript 當時是完全看不上這東西的,甚至帶著鄙視的心態,到不是因為它比原生 Js 要多寫很多代碼而是

作為一名前端老兵遇上 Typescript 的語法與型別就會讓我想起剛作業時學習的 Flash Actionscript3.0 腳本時代,不能說是完全相同,簡直是一模一樣,

大約2006年 Adobe 的 flash 9 就開發了自己的新腳本語言 ActionScript 3 完全符合 ECMAScript 第四版規范, 也就是ES4

與當時代的 Javascript 還處于刀耕火種不同,在 Flash 編輯器中使用 ActionScript3 撰寫代碼就有了比較完善的型別檢測與型別提示,

曾經的 Actionscript3.0 輝煌的時代,那時影片有Flash, 應用有 Flex, 跨平臺桌面應用有 Adobe air ,后面還支持移動端,這些用的都是 Actionscript3.0 腳本

而 Actionscript3.0 在我熟練掌握后退出了歷史舞臺,,,多棒的腳本語言啊,我又白學了,原因大致是 Adobe 的不上進和其它大公司的聯合圍剿

所以當我第一次接觸到 Typescript 的時候內心非常抵觸,

這幾年 Javascript 跟其它語言相比可能還差一大截,但已和當年刀耕火種不同,前端工具與框架層出不窮,快速更新迭代 web 應用越來越復雜,前端工具越來越成熟,Typescript 的應用

也就水到渠成了,當在團隊中使用 Typescript 雖然多寫了點兒型別代碼,但是好處太多了,可以說是用了就回不去了

我們這樣的小角色怎能與時代洪流相抵呢,隨波逐流吧,學吧學到廢為止

如果你學過 Actionscript3 那么對 Typescript 中普通的,類、介面、繼承、變數型別等概念與語法就會非常熟悉

唯一沒有且用的比較廣泛的概念當屬 Typescirpt 中的 "泛型" , 泛型的理解與運用自我感覺是比較難的,但又不能不面對,只能多看多學了

我所學到與理解的也是看的其它人分享的資料,拾人牙慧

最討厭別人寫的文章、書,上來就是一堆概念和名詞解釋,把你繞的云里霧里

我希望的是從實際運用出發,從問題開始找解決方案,也就是學了干啥用,得學以致用才能更好的理解

以下假設你已經對 Typescript 已經有了一定的基礎了解

如果你從未學過 Typescript 那么請退出先去學基礎!


一、回呼函式的型別提示


注冊自定義事件,傳入的回呼函式,如果事件型別(事件名)對應的回呼函式內回呼引數不一樣

那么回呼函式的型別注釋我們無能為力,只能用 any ,如下 addEvent 函式,用于注冊事件

eventType 定義為 string 型別

listener 這個是函式 Function, 但由于事件型別有多種,對應的回呼函式也有好多種

這就尬住了,暫時只能用 (...args: any[]) => any 來作為 listener 的型別

但這樣還是沒有辦法明確 listener 里邊有多少個具體的引數以及型別

// 自定義注冊事件函式的型別注釋

const addEvent = (eventType: string, listener:(...args: any[]) => any) => {
    console.log(eventType, listener);
    
}

addEvent('eventTypeName1', () => { 

})

如果是這樣,那么 呼叫 addEvent 時回呼函式是沒有任何有用的提示的

尬住了是不是
eventType 不同,對應的 listener 也不同
這時就應該想是不是能用泛型來解決,泛型就是在傳入的時候才確寫具體的型別約束

  1. 先建一個用于映射的型別物件 MyEventMap, key 是 eventType 型別, value 是對應的 listener 型別
  2. 添加泛型 T
  3. 用 extends keyof MyEventMap 約束 T 在 MyEventMap 的 key 范圍內,而key 范圍又是通過 keyof 來提取的
  4. listener 的型別通過 MyEventMap[T] 來獲取
type MyEventMap = {
    'eventTypeName1': (a: string) => number
    'eventTypeName2': (test: boolean) => string[]
}

const addEvent = <T extends keyof MyEventMap>(eventType: T, listener: MyEventMap[T]) => {
    console.log(eventType, listener);
}


addEvent('eventTypeName1', (a) => { 
    return 1
})

這樣就有提示了,看效果

兩個關鍵點

  • extends 來約束 eventType
  • MyEventMap[T] 來獲取具體的 listener 型別

二、代理 DOM 事件的型別注釋


比如你自己在寫 Js 框架,其中需求是要實作 addEventListener 的代理函式,如何給這個代理函式寫ts注釋呢?

on('click', ()=> {}) 這樣的方法,且能提示 Typescript 默認提供的型別,并約束 eventName 在dom事件

const on = (eventName: string,  listener: (...args: any[]) => any) => {
    console.log(eventName, listener);
}

這樣寫也通過了檢測...那肯定不行,因為需求是約束為 dom 事件,但現在約束了eventName為 string

on('click', () => {

})

又尬住了,我們得在 ts 提供的 lib.dom.d.ts 檔案內找答案

原始碼中找到 interface HTMLElement 的介面定義

addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;

顯然 HTMLElementEventMap 就是我們要找的通過 eventName 映射 具體回呼的 Map

那就和上面自定義注冊函式一樣處理就可以了即

const on = <T extends keyof HTMLElementEventMap>(eventName: T,  listener: (this: HTMLElement, ev: HTMLElementEventMap[T]) => any, options?: boolean | AddEventListenerOptions) => {
    console.log(eventName, listener, options);
}

這樣就都有正常的提示了

on('mousedown', (e) => {
    console.log(e)
})

on('paste', (e) => {
    console.log(e)
})


三、fetch 的 ts 注釋


很多情況下,我們會給 fetch 請求回來的函式用 data as User[] 來主動告訴編譯器回傳資料的型別, 雖然能用,但不優雅

我們會順著思路,我們試試給 fetch 請求函式作 ts 注釋

一樣先建一個 ResponseMap ,key 是 三、fetch 請求地址 value 是 fetch 回傳的資料型別

type ResponseMap = {
    'hello/world': number
    'test/getlist': string[]
}
const get = async <T extends keyof ResponseMap>(url: T):Promise<ResponseMap[T]> => {
    const response = await fetch(url);
    return response.json();
}

測驗一下

get('hello/world')

get('test/getlist')

試了一下挺完美,但是,但是,肯定沒這么簡單,請求地址很多情況下是帶有引數的

get('test/getlist?a=1&b=2')

發現提示錯誤,通不過校驗了

果然型別很麻煩,,,

!!!需要改進一下泛型匹配

const get = async <T extends keyof ResponseMap>(url: T  | `${T}?${string}`):Promise<ResponseMap[T]> => {
    const response = await fetch(url);
    return response.json();
}


get('test/getlist?a=1&b=2')

這下可以通過校驗了,提示也正常作業

關鍵在于

url: T | ${T}?${string}

這一句的改動, 通過字串模板提取出 T 來


最后,人家的建議是泛型也需要更友好的命名,T、K、R、等等都太不友好了,可以更具名化如下, 把范圍名字變的更具體


const addEvent = <EventType extends keyof MyEventMap>(eventType: EventType, listener: MyEventMap[EventType]) => {
    console.log(eventType, listener);
}

const get = async <FetchUrl extends keyof ResponseMap>(url: FetchUrl  | `${FetchUrl}?${string}`):Promise<ResponseMap[FetchUrl]> => {
    const response = await fetch(url);
    return response.json();
}

說明:以上知識是看到國外某個講 typescript 的視頻中學到的,沒找到原視頻內容,當然很多英文內容也沒有翻譯,我只是把理解的知識轉化一下,所以才叫拾人牙慧么...


cnblogs.com/willian/

https://github.com/willian12345

轉載請註明出處,本文鏈接:https://www.uj5u.com/qiye/544764.html

標籤:Html/Css

上一篇:對window.onload()的理解

下一篇:JavaScript 中 map(parseInt) 的問題解決

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • IEEE1588PTP在數字化變電站時鐘同步方面的應用

    IEEE1588ptp在數字化變電站時鐘同步方面的應用 京準電子科技官微——ahjzsz 一、電力系統時間同步基本概況 隨著對IEC 61850標準研究的不斷深入,國內外學者提出基于IEC61850通信標準體系建設數字化變電站的發展思路。數字化變電站與常規變電站的顯著區別在于程序層傳統的電流/電壓互 ......

    uj5u.com 2020-09-10 03:51:52 more
  • HTTP request smuggling CL.TE

    CL.TE 簡介 前端通過Content-Length處理請求,通過反向代理或者負載均衡將請求轉發到后端,后端Transfer-Encoding優先級較高,以TE處理請求造成安全問題。 檢測 發送如下資料包 POST / HTTP/1.1 Host: ac391f7e1e9af821806e890 ......

    uj5u.com 2020-09-10 03:52:11 more
  • 網路滲透資料大全單——漏洞庫篇

    網路滲透資料大全單——漏洞庫篇漏洞庫 NVD ——美國國家漏洞庫 →http://nvd.nist.gov/。 CERT ——美國國家應急回應中心 →https://www.us-cert.gov/ OSVDB ——開源漏洞庫 →http://osvdb.org Bugtraq ——賽門鐵克 →ht ......

    uj5u.com 2020-09-10 03:52:15 more
  • 京準講述NTP時鐘服務器應用及原理

    京準講述NTP時鐘服務器應用及原理京準講述NTP時鐘服務器應用及原理 安徽京準電子科技官微——ahjzsz 北斗授時原理 授時是指接識訓通過某種方式獲得本地時間與北斗標準時間的鐘差,然后調整本地時鐘使時差控制在一定的精度范圍內。 衛星導航系統通常由三部分組成:導航授時衛星、地面檢測校正維護系統和用戶 ......

    uj5u.com 2020-09-10 03:52:25 more
  • 利用北斗衛星系統設計NTP網路時間服務器

    利用北斗衛星系統設計NTP網路時間服務器 利用北斗衛星系統設計NTP網路時間服務器 安徽京準電子科技官微——ahjzsz 概述 NTP網路時間服務器是一款支持NTP和SNTP網路時間同步協議,高精度、大容量、高品質的高科技時鐘產品。 NTP網路時間服務器設備采用冗余架構設計,高精度時鐘直接來源于北斗 ......

    uj5u.com 2020-09-10 03:52:35 more
  • 詳細解讀電力系統各種對時方式

    詳細解讀電力系統各種對時方式 詳細解讀電力系統各種對時方式 安徽京準電子科技官微——ahjzsz,更多資料請添加VX 衛星同步時鐘是我京準公司開發研制的應用衛星授時時技術的標準時間顯示和發送的裝置,該裝置以M國全球定位系統(GLOBAL POSITIONING SYSTEM,縮寫為GPS)或者我國北 ......

    uj5u.com 2020-09-10 03:52:45 more
  • 如何保證外包團隊接入企業內網安全

    不管企業規模的大小,只要企業想省錢,那么企業的某些服務就一定會采用外包的形式,然而看似美好又經濟的策略,其實也有不好的一面。下面我通過安全的角度來聊聊使用外包團的安全隱患問題。 先看看什么服務會使用外包的,最常見的就是話務/客服這種需要大量重復性、無技術性的服務,或者是一些銷售外包、特殊的職能外包等 ......

    uj5u.com 2020-09-10 03:52:57 more
  • PHP漏洞之【整型數字型SQL注入】

    0x01 什么是SQL注入 SQL是一種注入攻擊,通過前端帶入后端資料庫進行惡意的SQL陳述句查詢。 0x02 SQL整型注入原理 SQL注入一般發生在動態網站URL地址里,當然也會發生在其它地發,如登錄框等等也會存在注入,只要是和資料庫打交道的地方都有可能存在。 如這里http://192.168. ......

    uj5u.com 2020-09-10 03:55:40 more
  • [GXYCTF2019]禁止套娃

    git泄露獲取原始碼 使用GET傳參,引數為exp 經過三層過濾執行 第一層過濾偽協議,第二層過濾帶引數的函式,第三層過濾一些函式 preg_replace('/[a-z,_]+\((?R)?\)/', NULL, $_GET['exp'] (?R)參考當前正則運算式,相當于匹配函式里的引數 因此傳遞 ......

    uj5u.com 2020-09-10 03:56:07 more
  • 等保2.0實施流程

    流程 結論 ......

    uj5u.com 2020-09-10 03:56:16 more
最新发布
  • 使用Django Rest framework搭建Blog

    在前面的Blog例子中我們使用的是GraphQL, 雖然GraphQL的使用處于上升趨勢,但是Rest API還是使用的更廣泛一些. 所以還是決定回到傳統的rest api framework上來, Django rest framework的官網上給了一個很好用的QuickStart, 我參考Qu ......

    uj5u.com 2023-04-20 08:17:54 more
  • 記錄-new Date() 我忍你很久了!

    這里給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 大家平時在開發的時候有沒被new Date()折磨過?就是它的諸多怪異的設定讓你每每用的時候,都可能不小心踩坑。造成程式意外出錯,卻一下子找不到問題出處,那叫一個煩透了…… 下面,我就列舉它的“四宗罪”及應用思考 可惡的四宗罪 1. Sa ......

    uj5u.com 2023-04-20 08:17:47 more
  • 使用Vue.js實作文字跑馬燈效果

    實作文字跑馬燈效果,首先用到 substring()截取 和 setInterval計時器 clearInterval()清除計時器 效果如下: 實作代碼如下: <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta ......

    uj5u.com 2023-04-20 08:12:31 more
  • JavaScript 運算子

    JavaScript 運算子/運算子 在 JavaScript 中,有一些運算子可以使代碼更簡潔、易讀和高效。以下是一些常見的運算子: 1、可選鏈運算子(optional chaining operator) ?.是可選鏈運算子(optional chaining operator)。?. 可選鏈操 ......

    uj5u.com 2023-04-20 08:02:25 more
  • CSS—相對單位rem

    一、概述 rem是一個相對長度單位,它的單位長度取決于根標簽html的字體尺寸。rem即root em的意思,中文翻譯為根em。瀏覽器的文本尺寸一般默認為16px,即默認情況下: 1rem = 16px rem布局原理:根據CSS媒體查詢功能,更改根標簽的字體尺寸,實作rem單位隨螢屏尺寸的變化,如 ......

    uj5u.com 2023-04-20 08:02:21 more
  • 我的第一個NPM包:panghu-planebattle-esm(胖虎飛機大戰)使用說明

    好家伙,我的包終于開發完啦 歡迎使用胖虎的飛機大戰包!! 為你的主頁添加色彩 這是一個有趣的網頁小游戲包,使用canvas和js開發 使用ES6模塊化開發 效果圖如下: (覺得圖片太sb的可以自己改) 代碼已開源!! Git: https://gitee.com/tang-and-han-dynas ......

    uj5u.com 2023-04-20 08:01:50 more
  • 如何在 vue3 中使用 jsx/tsx?

    我們都知道,通常情況下我們使用 vue 大多都是用的 SFC(Signle File Component)單檔案組件模式,即一個組件就是一個檔案,但其實 Vue 也是支持使用 JSX 來撰寫組件的。這里不討論 SFC 和 JSX 的好壞,這個仁者見仁智者見智。本篇文章旨在帶領大家快速了解和使用 Vu ......

    uj5u.com 2023-04-20 08:01:37 more
  • 【Vue2.x原始碼系列06】計算屬性computed原理

    本章目標:計算屬性是如何實作的?計算屬性快取原理以及洋蔥模型的應用?在初始化Vue實體時,我們會給每個計算屬性都創建一個對應watcher,我們稱之為計算屬性watcher ......

    uj5u.com 2023-04-20 08:01:31 more
  • http1.1與http2.0

    一、http是什么 通俗來講,http就是計算機通過網路進行通信的規則,是一個基于請求與回應,無狀態的,應用層協議。常用于TCP/IP協議傳輸資料。目前任何終端之間任何一種通信方式都必須按Http協議進行,否則無法連接。tcp(三次握手,四次揮手)。 請求與回應:客戶端請求、服務端回應資料。 無狀態 ......

    uj5u.com 2023-04-20 08:01:10 more
  • http1.1與http2.0

    一、http是什么 通俗來講,http就是計算機通過網路進行通信的規則,是一個基于請求與回應,無狀態的,應用層協議。常用于TCP/IP協議傳輸資料。目前任何終端之間任何一種通信方式都必須按Http協議進行,否則無法連接。tcp(三次握手,四次揮手)。 請求與回應:客戶端請求、服務端回應資料。 無狀態 ......

    uj5u.com 2023-04-20 08:00:32 more