/** * Copyright 2020 Inrupt Inc. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal in * the Software without restriction, including without limitation the rights to use, * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the * Software, and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ import { Literal, NamedNode } from "rdf-js"; import { Thing, UrlString, ThingLocal, ThingPersisted, Url } from "../interfaces"; /** * Create a new Thing with a URL added for a Predicate. * * This preserves existing values for the given Predicate. To replace them, see [[setUrl]]. * * The original `thing` is not modified; this function returns a cloned Thing with updated values. * * @param thing Thing to add a URL value to. * @param predicate Predicate for which to add the given URL value. * @param url URL to add to `thing` for the given `predicate`. * @returns A new Thing equal to the input Thing with the given value added for the given Predicate. */ export declare const addUrl: AddOfType; /** @hidden Alias for [[addUrl]] for those who prefer IRI terminology. */ export declare const addIri: AddOfType & { url: string; }) | (import("rdf-js").DatasetCore & { name: string; })>; /** * Create a new Thing with a boolean added for a Predicate. * * This preserves existing values for the given Predicate. To replace them, see [[setBoolean]]. * * The original `thing` is not modified; this function returns a cloned Thing with updated values. * * @param thing Thing to add a boolean value to. * @param predicate Predicate for which to add the given boolean value. * @param value Boolean to add to `thing` for the given `predicate`. * @returns A new Thing equal to the input Thing with the given value added for the given Predicate. */ export declare const addBoolean: AddOfType; /** * Create a new Thing with a datetime added for a Predicate. * * This preserves existing values for the given Predicate. To replace them, see [[setDatetime]]. * * The original `thing` is not modified; this function returns a cloned Thing with updated values. * * @param thing Thing to add a datetime value to. * @param predicate Predicate for which to add the given datetime value. * @param value Datetime to add to `thing` for the given `predicate`. * @returns A new Thing equal to the input Thing with the given value added for the given Predicate. */ export declare const addDatetime: AddOfType; /** * Create a new Thing with a decimal added for a Predicate. * * This preserves existing values for the given Predicate. To replace them, see [[setDecimal]]. * * The original `thing` is not modified; this function returns a cloned Thing with updated values. * * @param thing Thing to add a decimal value to. * @param predicate Predicate for which to add the given decimal value. * @param value Decimal to add to `thing` for the given `predicate`. * @returns A new Thing equal to the input Thing with the given value added for the given Predicate. */ export declare const addDecimal: AddOfType; /** * Create a new Thing with an integer added for a Predicate. * * This preserves existing values for the given Predicate. To replace them, see [[setInteger]]. * * The original `thing` is not modified; this function returns a cloned Thing with updated values. * * @param thing Thing to add an integer value to. * @param predicate Predicate for which to add the given integer value. * @param value Integer to add to `thing` for the given `predicate`. * @returns A new Thing equal to the input Thing with the given value added for the given Predicate. */ export declare const addInteger: AddOfType; /** * Create a new Thing with a localised string added for a Predicate. * * This preserves existing values for the given Predicate. To replace them, see [[setStringInLocale]]. * * The original `thing` is not modified; this function returns a cloned Thing with updated values. * * @param thing Thing to add a localised string value to. * @param predicate Predicate for which to add the given string value. * @param value String to add to `thing` for the given `predicate`. * @param locale Locale of the added string. * @returns A new Thing equal to the input Thing with the given value added for the given Predicate. */ export declare function addStringInLocale(thing: T, predicate: Url | UrlString, value: string, locale: string): T extends ThingLocal ? ThingLocal : ThingPersisted; /** * Create a new Thing with an unlocalised string added for a Predicate. * * This preserves existing values for the given Predicate. To replace them, see [[setStringUnlocalized]]. * * The original `thing` is not modified; this function returns a cloned Thing with updated values. * * @param thing Thing to add an unlocalised string value to. * @param predicate Predicate for which to add the given string value. * @param value String to add to `thing` for the given `predicate`. * @returns A new Thing equal to the input Thing with the given value added for the given Predicate. */ export declare const addStringUnlocalized: AddOfType; /** * Create a new Thing with a Named Node added for a Predicate. * * This preserves existing values for the given Predicate. To replace them, see [[setNamedNode]]. * * The original `thing` is not modified; this function returns a cloned Thing with updated values. * * @ignore This should not be needed due to the other add*One() functions. If you do find yourself needing it, please file a feature request for your use case. * @param thing The [[Thing]] to add a Named Node to. * @param predicate Predicate for which to add a value. * @param value The Named Node to add. * @returns A new Thing equal to the input Thing with the given value added for the given Predicate. */ export declare function addNamedNode(thing: T, predicate: Url | UrlString, value: NamedNode): T extends ThingLocal ? ThingLocal : ThingPersisted; /** * Create a new Thing with a Literal added for a Predicate. * * This preserves existing values for the given Predicate. To replace them, see [[setLiteral]]. * * The original `thing` is not modified; this function returns a cloned Thing with updated values. * * @ignore This should not be needed due to the other add*One() functions. If you do find yourself needing it, please file a feature request for your use case. * @param thing The [[Thing]] to add a Literal to. * @param predicate Predicate for which to add a value. * @param value The Literal to add. * @returns A new Thing equal to the input Thing with the given value added for the given Predicate. */ export declare function addLiteral(thing: T, predicate: Url | UrlString, value: Literal): T extends ThingLocal ? ThingLocal : ThingPersisted; /** * @param thing Thing to add a value to. * @param predicate Predicate on which to add the given value. * @param value Value to add to `thing` for the given `predicate`. * @returns A new Thing equal to the input Thing with the given value removed for the given Predicate. */ declare type AddOfType = (thing: T, predicate: Url | UrlString, value: Type) => T extends ThingLocal ? ThingLocal : ThingPersisted; export {};