diff --git a/napi.h b/napi.h index 870a5c290..486f44c0f 100644 --- a/napi.h +++ b/napi.h @@ -422,12 +422,16 @@ class BasicEnv { #endif // NAPI_VERSION > 8 #ifdef NODE_API_EXPERIMENTAL_HAS_POST_FINALIZER + // FinalizerType must implement `void operator()(Env env)`. template inline void PostFinalizer(FinalizerType finalizeCallback) const; + // FinalizerType must implement `void operator()(Env env, T* data)`. template inline void PostFinalizer(FinalizerType finalizeCallback, T* data) const; + // FinalizerType must implement `void operator()(Env env, T* data, + // Hint* hint)`. template inline void PostFinalizer(FinalizerType finalizeCallback, T* data, @@ -1107,9 +1111,12 @@ class Object : public TypeTaggable { const Function& constructor ///< Constructor function ) const; + // Finalizer must implement `void operator()(Env env, T* data)`. template inline void AddFinalizer(Finalizer finalizeCallback, T* data) const; + // Finalizer must implement `void operator()(Env env, T* data, + // Hint* hint)`. template inline void AddFinalizer(Finalizer finalizeCallback, T* data, @@ -1157,7 +1164,8 @@ class External : public TypeTaggable { // Finalizer must implement `void operator()(Env env, T* data)`. template static External New(napi_env env, T* data, Finalizer finalizeCallback); - // Finalizer must implement `void operator()(Env env, T* data, Hint* hint)`. + // Finalizer must implement `void operator()(Env env, T* data, + // Hint* hint)`. template static External New(napi_env env, T* data, @@ -1712,7 +1720,8 @@ class Buffer : public Uint8Array { T* data, size_t length, Finalizer finalizeCallback); - // Finalizer must implement `void operator()(Env env, T* data, Hint* hint)`. + // Finalizer must implement `void operator()(Env env, T* data, + // Hint* hint)`. template static Buffer New(napi_env env, T* data, @@ -1728,7 +1737,8 @@ class Buffer : public Uint8Array { T* data, size_t length, Finalizer finalizeCallback); - // Finalizer must implement `void operator()(Env env, T* data, Hint* hint)`. + // Finalizer must implement `void operator()(Env env, T* data, + // Hint* hint)`. template static Buffer NewOrCopy(napi_env env, T* data, @@ -2825,6 +2835,7 @@ class ThreadSafeFunction { ContextType* context); // This API may only be called from the main thread. + // Finalizer must implement `void operator()(Env env)`. template static ThreadSafeFunction New(napi_env env, const Function& callback, @@ -2834,6 +2845,8 @@ class ThreadSafeFunction { Finalizer finalizeCallback); // This API may only be called from the main thread. + // Finalizer must implement + // `void operator()(Env env, FinalizerDataType* data)`. template @@ -2846,6 +2859,8 @@ class ThreadSafeFunction { FinalizerDataType* data); // This API may only be called from the main thread. + // Finalizer must implement + // `void operator()(Env env, ContextType* context)`. template static ThreadSafeFunction New(napi_env env, const Function& callback, @@ -2856,6 +2871,8 @@ class ThreadSafeFunction { Finalizer finalizeCallback); // This API may only be called from the main thread. + // Finalizer must implement `void operator()(Env env, + // FinalizerDataType* data, ContextType* context)`. template static ThreadSafeFunction New(napi_env env, const Function& callback, @@ -2899,6 +2917,8 @@ class ThreadSafeFunction { Finalizer finalizeCallback); // This API may only be called from the main thread. + // Finalizer must implement + // `void operator()(Env env, FinalizerDataType* data)`. template @@ -2912,6 +2932,8 @@ class ThreadSafeFunction { FinalizerDataType* data); // This API may only be called from the main thread. + // Finalizer must implement + // `void operator()(Env env, ContextType* context)`. template static ThreadSafeFunction New(napi_env env, const Function& callback, @@ -2923,6 +2945,8 @@ class ThreadSafeFunction { Finalizer finalizeCallback); // This API may only be called from the main thread. + // Finalizer must implement `void operator()(Env env, + // FinalizerDataType* data, ContextType* context)`. template @@ -3082,6 +3108,8 @@ class TypedThreadSafeFunction { // This API may only be called from the main thread. // Creates a new threadsafe function with: // Callback [missing] Resource [passed] Finalizer [passed] + // Finalizer must implement `void operator()(Env env, + // FinalizerDataType* data, ContextType* context)`. template @@ -3124,6 +3152,8 @@ class TypedThreadSafeFunction { // This API may only be called from the main thread. // Creates a new threadsafe function with: // Callback [passed] Resource [missing] Finalizer [passed] + // Finalizer must implement `void operator()(Env env, + // FinalizerDataType* data, ContextType* context)`. template @@ -3140,6 +3170,8 @@ class TypedThreadSafeFunction { // This API may only be called from the main thread. // Creates a new threadsafe function with: // Callback [passed] Resource [passed] Finalizer [passed] + // Finalizer must implement `void operator()(Env env, + // FinalizerDataType* data, ContextType* context)`. template