Skip to content

Add null value and Setting type #2478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions specification/_spec_utils/utils.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

import { Stringified } from '@spec_utils/Stringified'

/**
* A `null` value that is to be interpreted as an actual value, unless other uses of `null` that are equivalent
* to a missing value. It is used for exemple in settings, where using the `NullValue` for a setting will reset
* it to its default value.
*/
type NullValue = null

/**
* Settings in Elasticsearch are values that can be reset to their default by setting them to the `null` value.
*
* @es_quirk Because of how they are implemented internally, settings are always returned as strings, even
* if their value has been set using a primitive type.
*/
type Setting<T> = Stringified<T> | NullValue