---
name: "Prelude.onDestroy"
section: "3kaya"
platform: "linux"
package: "kaya"
version: "0.4.4-6.2"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/Prelude.onDestroy"
---

# Prelude.onDestroy(3kaya)

Register a function to call when object is garbage collected

## NAME

Prelude::onDestroy - Register a function to call when object is garbage collected

## SYNOPSIS

**Void onDestroy(** *var a object, var Void(a) destroyFn* **)**

## ARGUMENTS

**object** The object being watched

**destroyFn** The function to call when the object is destroyed. Takes the object as its argument

## DESCRIPTION

If additional cleanup is needed when an object is destroyed, this function registers a finalisation procedure. e.g. a record containing a file handle should make sure the file is closed when the object is deallocated.

## AUTHORS

Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/

## LICENSE

The Kaya standard library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License (version 2.1 or any later version) as published by the Free Software Foundation.
